StreamServe Persuasion SP5 Archive Web Service

Transcription

1 StreamServe Persuasion SP5 Archive Web Service Programmer s Guide Rev A

2 StreamServe Persuasion SP5 Archive Web Service Programmer s Guide Rev A STREAMSERVE, INC. ALL RIGHTS RESERVED United States patent #7,127,520 No part of this document may be reproduced or transmitted in any form or by any means, electronic or mechanical, for any purpose, without the express written permission of StreamServe, Inc. Information in this document is subject to change without notice. StreamServe Inc. assumes no responsibility or liability for any errors or inaccuracies that may appear in this book. All registered names, product names and trademarks of other companies mentioned in this documentation are used for identification purposes only and are acknowledged as property of the respective company. Companies, names and data used in examples in this document are fictitious unless otherwise noted. StreamServe, Inc. offers no guarantees and assumes no responsibility or liability of any type with respect to third party products and services, including any liability resulting from incompatibility between the third party products and services and the products and services offered by StreamServe, Inc. By using StreamServe and the third party products mentioned in this document, you agree that you will not hold StreamServe, Inc. responsible or liable with respect to the third party products and services or seek to do so. The trademarks, logos, and service marks in this document are the property of StreamServe, Inc. or other third parties. You are not permitted to use the marks without the prior written consent of StreamServe, Inc. or the third party that owns the marks. Use of the StreamServe product with third party products not mentioned in this document is entirely at your own risk, also as regards the StreamServe products. StreamServe Web Site

3 1 Contents Introduction...3 Archive web service...5 batchdeletedocuments...6 createannotation...7 createdocuments...8 createdocumentsb createdocumenttypes...12 deleteannotations...13 deletedocuments...14 documentsearch...15 getalldocumenttypes...17 getannotations...18 getdocumentlxfdata...19 getdocuments...20 getdocumentsb getdocumentsb64ex...22 getdocumentsdetails...23 getinternaldocumenttypes...24 getmetadatafordoctype...25 reprocessdocument...26 updatedocumentmetadata...28 Data types...29 Type values strs:arrayofmetadata strs:arrayofmetadataex strs:arrayofstrings strs:document strs:document_base strs:documentanddetails strs:documentdetail strs:documentsanddetails strs:metadata strs:metadataex archman:batchdeletedocumentsrequest archman:batchdeletedocumentsresponse archman:createannotationrequest archman:createannotationresponse archman:createdocumenttypesrequest archman:createdocumenttypesresponse StreamServe Persuasion SP5Archive Web Service Programmer s Guide Rev A

4 2 archman:deleteannotationsrequest archman:documentanddetailsb archman:documentanddetailsb64ex archman:documentsanddetailsb archman:documentsanddetailsb64ex archman:documentresponsetype archman:documentresponsetypes archman:documentsearchresponse archman:getalldocumenttypesresponse archman:getannotationsrequest archman:getannotationsresponse archman:getdocumentlxfdataresponse archman:getdocumentsb64response archman:getdocumentsb64exresponse archman:getdocumentsdetailsresponse archman:getdocumentsresponse archman:getinternaldocumenttypesresponse archman:getmetadatafordoctyperequest archman:getmetadatafordoctyperesponse archman:reprocessdocumentrequest archman:searchcriteria archman:updatedocumentmetadatatype Appendix A - Status codes from web services...43 HTTP responses SOAP responses StreamServe Persuasion SP5Archive Web Service Programmer s Guide Rev A

5 3 Introduction The StreamServe service gateway uses the HTTP protocol to invoke web services. To make the programming interface easier, a client normally uses a framework such as.net, Apache Axis or gsoap to call a web service. The Archive web service SDK Included in the SDK package are: WSDL file, describing the web service. XSD file, XML schema definition Contact StreamServe Support. About Archive web services WSDL StreamServe supports WSDL 1.2. SOAP The service gateway uses the SOAPAction HTTP header value to identify the web service to be invoked. Example 1 SOAPAction HTTP header SOAPAction: "urn:myservice/foobar/foo" Note: The service gateway can also identify the service to be invoked from the following field in the HTTP header: Content-Type: <attribute> action=<url> For example: Content-Type: application/soap+xml; charset=utf-8; action= repositorydocument/1.0/createdocument WS-Addressing, QName and other ways are not supported in this version. StreamServe supports SOAP 1.1 and 1.2.

6 4 Introduction

7 5 Archive web service The web services presented in this document can be used to read document types, annotations, documents and metadata from the Collector archive. Document annotations can be created and deleted. Note: Strings are case sensitive unless otherwise specified. Deleting documents It is possible to delete documents. You must be aware of that the deletion is permanent and the function should be used with care. Examples The examples in this document are presented as pseudo code.

8 6 batchdeletedocuments Archive web service batchdeletedocuments Syntax batchdeletedocuments( archman:batchdeletedocumentsrequest, archman:batchdeletedocumentsresponse): Description Delete document(s) based on creation date time and document type. If only fromtime is specified, all documents with a creationdatetime after fromtime will be deleted. If only totime is specified, all documents with a creationdatetime before totime will be deleted. Parameters Parameter Data type Description BatchDeleteDocumentsRequest archman:batchdeletedocumentsrequest See Description above. BatchDeleteDocumentsResponse archman:batchdeletedocumentsresponse Number of deleted documents. Example 2 Pseudo code usage example create the request object (archman:batchdeletedocumentsrequest) // delete all "Invoices" before :00:00 request.documenttypeid = "E9868A31-9CC2-4A7B-A3BD-4D32673B4C4B" request.totime = :00:00 request.blobonly = false call batchdeletedocuments with the request object print response.noofdocumentsdeleted

9 createannotation 7 Archive web service createannotation Syntax createannotation( archman:createannotationrequest,archman:createannotationresponse) Description Create annotation for a document. Parameters Parameter Data types Description CreateAnnotationRequest archman:createannotationrequest Defines documentid and annotation data. CreateAnnotationResponse archman:createannotationresponse ID of the created annotation.

10 8 createdocuments Archive web service createdocuments Syntax createdocuments( strs:documentsanddetails, archman:documentresponsetypes ): Description Creates new document(s) in the archive database. Any number of documents and metadata can be supplied in the request. The metadata must match the document type definition. Metadata that are not included in the request will be set to NULL in the archive database. Parameter Parameter Data types Description DocumentsAndDetails strs:documentsanddetails List of strs:documentanddet ails, containing data, document type, metadata. DocumentResponseTypes archman:documentresponsetypes List of archman:documentres ponsetype, containing documentid and result code. Example 3 Pseudo code usage example create a request object (strs:documentsanddetails) create a strs:documentdetail object (called dd here), this will hold the metadata // set some attributes dd.metadataname = "InvoiceNo" dd.metadataid = "b46e44aa-beb8-4d0e-8f33-c1137d272214" dd.metadatavalue = "123456" dd.metadatatype = 7 // integer create a strs:document object (called doc here), this will hold the data (i.e. the PDF) read the PDF file store the read data into the doc object (doc.data) create a strs:documentanddetails object (called dad here), this will hold the document and metadata add the strs:documentdetail object to the strs:documentanddetails object add the strs:document object to the strs:documentanddetails object // set some attributes

11 createdocuments 9 Archive web service dad.documenttypeid = "61bb0a10-e5ac c-8c ac0" dad.creationdatetime = :03:23 add the strs:documentanddetails object to the request object call createdocuments with the request object for responsetype in ResponseTypes if responsetype.result == 0 then doc with id responsetype.id was created! else responsetype.id failed! end if done

12 10 createdocumentsb64 Archive web service createdocumentsb64 Syntax createdocumentsb64( archman:documentsanddetailsb64, archman:documentresponsetypes ): Description Creates new document(s) in the archive database. Any number of documents and metadata can be supplied in the request. The metadata must match the document type definition. Metadata that are not included in the request will be set to NULL in the archive database. Parameter Parameter Data types Description archman:documentsanddeta ilsb64 archman:documentsanddetailsb64 List of archman:documentand DetailsB64, containing data, document type, metadata. DocumentResponseTypes archman:documentresponsetypes List of archman:documentres ponsetype, containing documentid and result code. Example 4 Pseudo code usage example create a request object (archman:documentsanddetailsb64) create a strs:documentdetail object (called dd here), this will hold the metadata // set some attributes dd.metadataname = "InvoiceNo" dd.metadataid = "b46e44aa-beb8-4d0e-8f33-c1137d272214" dd.metadatavalue = "123456" dd.metadatatype = 7 // integer create a strs:document_base64 object (called doc here), this will hold the data (i.e. the PDF) read the PDF file store the read data into the doc object (doc.data) create a archman:documentanddetailsb64 object (called dad here), this will hold the document and metadata add the strs:documentdetail object to the archman:documentanddetailsb64 object add the strs:document_base64 object to the archman:documentanddetailsb64 object

13 createdocumentsb64 11 Archive web service // set some attributes dad.documenttypeid = "61bb0a10-e5ac c-8c ac0" dad.creationdatetime = :03:23 add the archman:documentanddetailsb64 object to the request object call createdocuments with the request object for responsetype in ResponseTypes if responsetype.result == 0 then doc with id responsetype.id was created! else responsetype.id failed! end if done

14 12 createdocumenttypes Archive web service createdocumenttypes Syntax createdocumenttypes( archman:createdocumenttypesrequest, archman:createdocumenttypesresponse ): Description Create document type definitions in the archive database, based on a document_types.xml. If a document type already exists, it will be updated if the force update flag is set to true. Parameters Parameter Data type Description CreateDocumentTypesRequest archman:createdocumenttypesr equest XML document that contains the document type definitions (i.e. document_types.xml exported from Design Center) and a flag to force update on evaluation warning. CreateDocumentTypesResponse archman:createdocumenttypesr esponse Result code. 0 = success Example 5 Pseudo code usage example Create the request object (archman:createdocumenttypesrequest) // store the contents of document_types.xml in request.doc.data request.doc.data = new FileInputStream("document_types.xml"); // set the forceupdate flag to force update on evaluation warning request.forceupdate = true; Create the response object (archman:createdocumenttypesresponse) Call createdocumenttypes and check the result if ( response.result == 0 ) // success! else // failure!

15 deleteannotations 13 Archive web service deleteannotations Syntax deleteannotations(archman:deleteannotationsrequest, archman:deleteannotationsresponse ): Description Delete annotation(s) for a document. Parameters Parameter Data type Description DeleteAnnotationsRequest archman:deleteannotationsrequest Defines the annotation(s) to be deleted. DeleteAnnotationsResponse - - Example 6 Pseudo code usage example create the request object (strs:arrayofstrings) add some annotationids to the request object call deleteannotations with the request object

16 14 deletedocuments Archive web service deletedocuments Syntax deletedocuments( strs:documentsanddetails, archman:documentresponsetypes ): Description Delete document(s) from the archive. The request must contain the parameter documentid. If the request does not contain the parameter documenttypeid, performance may be decreased since the document must then be looked up. This function means that the defined documents are permanently deleted from the archive. Parameters Parameter Data type Description DocumentsAndDetails strs:documentsanddetails List of document details containing documentid, strs:documentanddetails DocumentResponseTypes archman:documentresponsetypes List containing documentid and result code, archman:documentresponse Type Example 7 Pseudo code usage example create a request object (strs:documentsanddetails) create a strs:documentanddetails object // initialize it with documentid and documenttypeid document.documentid = "5E F5E ABFE-8AAAB00C4370" document.documenttypeid = "E9868A31-9CC2-4A7B-A3BD-4D32673B4C4B" / / this is opti add the strs:documentanddetails object to the request object call getdocuments with the request object for responsetype in ResponseTypes if responsetype.result > 0 then doc with id responsetype.id was deleted! else responsetype.id failed! end if done

17 documentsearch 15 Archive web service documentsearch Syntax documentsearch(archman:searchcriteria, archman:documentsearchresponse): Description Search for documents in the archive, as defined in the search criteria. The response is a list of document details as defined by the out parameter. Note: If the creationdatetimevalues parameter is omitted the default search will, for performance reasons, be max for the last 30 days. Parameters Parameter Data type Description SearchCriteria archman:searchcriteria Defines search criteria: list of document type IDs, search parameters and out parameters (metadata in the response) creation date time sort parameters DocumentSearchResponse archman:documentsearchresponse The response contains a list of document details (documentid, documenttypeid) and metadata as specified in the out parameter. Example 8 Pseudo code usage example create a request object (archman:searchcriteria) create a strs:arrayofstrings object to hold the document type IDs // add some document type IDs doctypeids[0] = "E9868A31-9CC2-4A7B-A3BD-4D32673B4C4B" doctypeids[1] = "7003AF14-ABFE FA0-97DEDE956EA3" // initialize the request object req.creationdatetimevalues = " :00: :00:00.000" req.maxnoofresults = 20 req.startrow = 1 req.sortmode = "ASC" req.sortparam = "b46e44aa-beb8-4d0e-8f33-c1137d272214"

18 16 documentsearch Archive web service create a strs:arrayofmetadataex object to hold the search parameters create a search param object (strs:metadataex) // initialize the search param object searchparam.name = "InvoiceNo" searchparam.id = "b46e44aa-beb8-4d0e-8f33-c1137d272214" searchparam.value = "12345" searchparam.type = 7 // integer add the search param object to the search params object add the search params object to the request object the same procedure applies for the out params object (to specify which meta(s) data to get in the response) call documentsearch with the request object iterate the response (strs:documentsanddetails), this will contain documentid, documenttypeid and the metadata as specified in the out parameters

19 getalldocumenttypes 17 Archive web service getalldocumenttypes Syntax getalldocumenttypes( archman:getalldocumenttypesresponse ): Description Get all document types in the archive except the internal document types. Parameters Parameter Data type Description GetAllDocumentTypesResponse archman:getalldocumenttypesresponse List of document type IDs and name. Example 9 Pseudo code usage example call getalldocumenttypes (no request object needed) iterate the response (strs:documentsanddetails), this will contain documenttypeid and documenttypename

20 18 getannotations Archive web service getannotations Syntax getannotations( archman:getannotationsrequest,archman:getannotationsresponses ): Description Get annotation(s) for a document. Parameters Parameter Data type Description GetAnnotationsRequest archman:getannotationsrequest Defines the document ID. GetAnnotationsResponses archman:getdocumentsresponse List of annotations ID and annotation data found.

21 getdocumentlxfdata 19 Archive web service getdocumentlxfdata Syntax getdocumentlxfdata( strs:documentanddetails, archman:getdocumentlxfdataresponse ): Description Get a device independent LXF copy of the archived document. The request must contain the parameter documentid. If the request does not contain the parameter documenttypeid, performance may be decreased since the document must then be looked up. Parameters Parameter Data type Description DocumentAndDetails strs:documentanddetails Document IDs and details. GetDocumentLxfDataResponse archman:getdocumentsresponse Contains a list of DocumentAndDetai ls No metadata. Example 10 Pseudo code usage example create a request object (strs:documentsanddetails) create a strs:documentanddetails object // initialize it with documentid and documenttypeid document.documentid = "5E F5E ABFE-8AAAB00C4370" document.documenttypeid = "E9868A31-9CC2-4A7B-A3BD-4D32673B4C4B" // this is opti add the strs:documentanddetails object to the request object call getdocuments with the request object the response (strs:documentanddetails) will contain documentid, documenttypeid, documenttypename and document lxf data (no metadata)

22 20 getdocuments Archive web service getdocuments Syntax getdocuments(strs:documentsanddetails,archman:getdocumentsresponse): Description Get document(s) from the archive. The binary content will be transferred as MTOM attachments The request must contain the parameter documentid. If the request does not contain the parameter documenttypeid, performance may be decreased, since the document must then be looked up. Parameters Parameter Data type Description DocumentsAndDetails strs:documentsanddetails List of document details, strs:documentanddetails GetDocumentsResponse archman:getdocumentsresponse List of document details (no metadata) found in the archive. Example 11 Pseudo code usage example create a request object (strs:documentsanddetails) create a strs:documentanddetails object // initialize it with document ID and document type ID document.documentid = "5E F5E ABFE-8AAAB00C4370" document.documenttypeid = "E9868A31-9CC2-4A7B-A3BD-4D32673B4C4B" / /this is opti add the strs:documentanddetails object to the request object call getdocuments with the request object iterate the response (strs:documentsanddetails), which contains documentid, documenttypeid, documenttypename and document data (no metadata)

23 getdocumentsb64 21 Archive web service getdocumentsb64 Syntax getdocumentsb64(strs:documentsanddetails,archman:getdocumentsresponse): Description Get document(s) from the archive. The binary content will base64 encoded. The request must contain the parameter documentid. If the request does not contain the parameter documenttypeid, performance may be decreased, since the document must then be looked up. Parameters Parameter Data type Description DocumentsAndDetailsB64 archman:documentsanddetailsb 64 List of document details, archman:documentanddetai lsb64 GetDocumentsB64Response archman:getdocumentsb64respo nse List of document details (no metadata) found in the archive. Example 12 Pseudo code usage example create a request object (strs:documentsanddetailsb64) create a strs:documentanddetails object // initialize it with document ID and document type ID document.documentid = "5E F5E ABFE-8AAAB00C4370" document.documenttypeid = "E9868A31-9CC2-4A7B-A3BD-4D32673B4C4B" / /this is opti add the strs:documentanddetails object to the request object call getdocuments with the request object iterate the response (strs:documentsanddetailsb64), which contains documentid, documenttypeid, documenttypename and document data (no metadata)

24 22 getdocumentsb64ex Archive web service getdocumentsb64ex Syntax getdocumentsb64ex(archman:documentsanddetailsb64ex,archman:getdoc umentsb64exresponse): Description Get document(s) from the archive. The binary content will base64 encoded. The request must contain the parameter documentid. If the request does not contain the parameter documenttypeid, performance may be decreased, since the document must then be looked up. Parameters Parameter Data type Description DocumentsAndDetailsB64Ex archman:documentsanddetailsb64ex List of document details archman:documentanddetailsb64e x GetDocumentsB64ExResponse archman:documentsanddetailsb64ex List of document details (no metadata) found in the archive. Example usage: Example 13 Usage example create a request object (archman:documentsanddetailsb64ex) create a archman:documentanddetailsb64ex object // initialize it with document ID and document type ID document.documentid = "5E F5E ABFE-8AAAB00C4370" document.documenttypeid = "E9868A31-9CC2-4A7B-A3BD-4D32673B4C4B" / /this is opti add the archman:documentanddetailsb64ex object to the request object call getdocumentsb64ex with the request object iterate the response (archman:documentsanddetailsb64ex), which contains documentid, documenttypeid, documenttypename and document data (no metadata)

25 getdocumentsdetails 23 Archive web service getdocumentsdetails Syntax getdocumentdetails (strs:documentsanddetails, archman:getdocumentdetailsresponse): Description Get document(s) details. The request must contain the parameter documentid. If the request does not contain the parameter documenttypeid, performance may be decreased since the document must then be looked up. Parameters Parameter Data type Description DocumentsAndDetails strs:documentsanddetails List of document IDs and details. GetDocumentDetailsResponse archman:getdocumentsdetailsresponse List of found documentid, DocumentTypeId and metadata. Example 14 Pseudo code usage example create the request object (strs:documentsanddetails) create a strs:documentanddetails object // initialize it with documentid and documenttypeid document.documentid = "5E F5E ABFE-8AAAB00C4370" document.documenttypeid = "E9868A31-9CC2-4A7B-A3BD-4D32673B4C4B" / / this is opti add the strs:documentanddetails object to the request object call getdocumentsdetails with the request object iterate the response (strs:documentsanddetails), this will contain documentid, documenttypeid and all metadata

26 24 getinternaldocumenttypes Archive web service getinternaldocumenttypes Syntax getinternaldocumenttypes( archman:getinternaldocumenttypesresponse): Description Get all internal document types: the document types that you do not get with the getinternaldocumenttypes function. Parameters Parameter Data type Description GetInternalDocumentTypes Response archman:getinternaldocumenttypes Response documenttypei D and name Example 15 Pseudo code usage example call getinternaldocumenttypes (no request object needed) iterate the response (strs:documentsanddetails), this will contain documenttypeid and documenttypename

27 getmetadatafordoctype 25 Archive web service getmetadatafordoctype Syntax getmetadatafordoctype( archman:getmetadatafordoctyperequest, archman:getmetadatafordoctyperesponse ): Description Get all metadata available for a document type. Parameters Parameter Data type Description GetMetaDataForDocTypeRequ est GetMetaDataForDocTypeResp onse archman:getmetadatafordoctyperequ est archman:getmetadatafordoctyperesp onse documenttypeid to get metadata for Lists all metadata (without values) for the defined document type. Example 16 Pseudo code usage example create the request object (archman:getmetadatafordoctyperequest) // set the document type Id request.documenttypeid = "E9868A31-9CC2-4A7B-A3BD-4D32673B4C4B" call getmetadatafordoctype with the request object iterate the response (strs:documentsanddetails), this will contain all metadata (without values)

28 26 reprocessdocument Archive web service reprocessdocument Syntax reprocessdocument( archman:reprocessdocumentrequest, archman:reprocessdocumentresponse ): Description Reprocess a document. This function requires that a device independent copy is available or that the preview project contains a proper filter to convert the actual document to LXF. Reprocess type can be: print fax mail The specified metadata is available as HTTP headers in the Project. Metadata in the document is also available as HTTP headers. Parameters Parameter Data type Description ReprocessDocumentRequest archman:reprocessdocumentrequest Reprocess type, DocumentID and a list of metadata. ReprocessDocumentResponse - - Example 17 Pseudo code usage example create the request object (archman:reprocessdocumentrequest) // initialize request.documentid = "5E F5E ABFE-8AAAB00C4370" request.reprocesstype = "print" create an array of metadata with channelinfo // initialize channelinfo[0].name = "strs- -from" channelinfo[0].value = "someadress@somedomain.com" channelinfo[1].name = "strs- -to" channelinfo[1].value = "someadress@somedomain.com" channelinfo[2].name = "strs- -message" channelinfo[2].value = "Test message" channelinfo[3].name = "strs- -cc" channelinfo[3].value = "someadress@somedomain.com" channelinfo[4].name = "strs- -bcc"

29 reprocessdocument 27 Archive web service channelinfo[4].value = "someadress@somedomain.com" channelinfo[5].name = "strs- -subject" channelinfo[5].value = "Reprocess test" channelinfo[6].name = "strs- -attachment" channelinfo[6].value = "file.pdf" call reprocessdocument with the request object

30 28 updatedocumentmetadata Archive web service updatedocumentmetadata Syntax updatedocumentmetadata( archman:updatedocumentmetadatatype, archman:updatedocumentmetadataresponsetype ): Description Updates the metadata value for a specific document. Parameters Parameter Data type Description UpdateDocumentMetaDataType UpdateDocumentMetaDataRes ponsetype archman:updatedocumentmetada tatype archman:updatedocumentmetada taresponsetype documentid, metadataid and value Empty response, check soap fault on error. Example 18 Pseudo code usage example Create the request object (archman:updatedocumentmetadatatype) // set documentid, metadataid and value request.documentid = "5E F5E ABFE-8AAAB00C4370"; request.metadataid = "b46e44aa-beb8-4d0e-8f33-c1137d272214"; request.value = "new value"; Call updatedocumentmetadata and check the soap response

31 29 Data types Type values Value Data type 2 string 3 date time 4 date time 7 integer 12 string (GUID) 14 double strs:arrayofmetadata strs:metadata item List of strs:metadata X strs:arrayofmetadataex strs:metadataex item List of strs:metadataex X strs:arrayofstrings xsd:string item List of xsd:strings X xsd:int current-idx Current index

32 30 Data types strs:document xsd:base64binary data Binary content, as MTOM attachment strs:document_base64 xsd:base64binary data Binary content coded as base64 strs:documentanddetails strs:documentdetail item List of strs:documentdetail X strs:document docs List of strs:document X xsd:string documentid Document GUID X xsd:string documenttypeid Document type GUID X xsd:string documenttypename Document type name X xsd:datetime creationdatetime Creation date time X xsd:string creationdatevalues Creation date values X xsd:int maxnoofresults Maximum number of results X xsd:int startrow Starting row X xsd:int totalcount Total count X xsd:datetime searchtimestamp Search time stamp X

33 Data types 31 strs:documentdetail xsd:string metadataname Metadata name X xsd:string metadatavalue Metadata value X xsd:string metadataid Metadata GUID X xsd:int metadatatype Metadata type, see Type values on page 29. X xsd:boolean metadataglobal true = global, false = local X xsd:boolean metadatafixed true = fixed, false = not fixed X strs:documentsanddetails strs:documentanddetails item List of strs:documentanddetails X strs:metadata xsd:string name Metadata name X xsd:string value Metadata value X xsd:string id Metadata GUID X

34 32 Data types strs:metadataex xsd:string name Metadata name X xsd:string value Metadata value X xsd:string id Metadata GUID X xsd:short type Metadata type, see Type values on page 29 archman:batchdeletedocumentsrequest xsd:string documenttypeid Document type GUID xsd:datetime fromtime From date time X xsd:datetime totime To date time X xsd:boolean blobonly Only remove blob or not archman:batchdeletedocumentsresponse xsd:int noofdocumentsdeleted Number of documents deleted

35 Data types 33 archman:createannotationrequest xsd:string documentid Document GUID xsd:string annotationdata Annotation text xsd:string principalobjectid Reserved parameter X xsd:datetime creationdatetime Creation date time X xsd:datetime expiringdatetime Expiring date time X archman:createannotationresponse xsd:string id GUID of the created annotation archman:createdocumenttypesrequest strs:document doc strs:document (as MTOM attachment) containing document_types.xml xsd:boolean forceupdate Force update on evaluation warning or not

36 34 Data types archman:createdocumenttypesresponse xsd:int result Result code, 0 = success archman:deleteannotationsrequest strs:arrayofstrings annotationids List of annotation GUIDs archman:documentanddetailsb64 strs:documentdetail item List of strs:documentdetail X strs:document_base64 docs List of strs:document_base64 X xsd:string documentid Document GUID X xsd:string documenttypeid Document type GUID X xsd:string documenttypename Document type name X xsd:datetime creationdatetime Creation date time X xsd:string creationdatevalues Creation date values X xsd:int maxnoofresults Maximum number of results X xsd:int startrow Starting row X xsd:int totalcount Total count X xsd:datetime searchtimestamp Search time stamp X archman:documentanddetailsb64ex strs:documentdetail item List of strs:documentdetail X

37 Data types 35 strs:document_base64 docs List of strs:document_base64 X xsd:string documentid Document GUID X xsd:string documenttypeid Document type GUID X xsd:string documenttypename Document type name X xsd:datetime creationdatetime Creation date time X xsd:string creationdatevalues Creation date values X xsd:int maxnoofresults Maximum number of results X xsd:int startrow Starting row X xsd:int totalcount Total count X xsd:datetime searchtimestamp Search time stamp X xsd:string contenttype Content type of the binary content X

38 36 Data types archman:documentsanddetailsb64 archman:documentanddetai lsb64 item List of archman:documentanddetailsb 64 X archman:documentsanddetailsb64ex archman:documentanddetai lsb64ex item List of archman:documentanddetailsb 64Ex X archman:documentresponsetype xsd:string id Document GUID xsd:int result Result code, 0 = success archman:documentresponsetypes archman:documentrespons etype item List of archman:documentresponsetype X archman:documentsearchresponse strs:documentsanddetail s documentsanddetails List of strs:documentanddetails found in the archive database

39 Data types 37 archman:getalldocumenttypesresponse strs:documentsanddetails List of strs:documentanddetails archman:getannotationsrequest xsd:string documentid Document GUID xsd:string principalobjectid Reserved parameter X xsd:boolean hideexpired Hide expired annotations or not archman:getannotationsresponse xsd:string documentid Document GUID xsd:string annotationid Annotation GUID xsd:string annotationdata Annotation data xsd:string principalobjectid Reserved parameter X xsd:datetime creationdatetime Annotation creation date time X xsd:datetime expiringdatetime Annotation expiring date time X

40 38 Data types archman:getdocumentlxfdataresponse strs:documentanddetails documentanddetails List of strs:documentanddetails X archman:getdocumentsb64response archman:documentsanddet ailsb64 documentsanddetails List of archman:documentanddetailsb 64 archman:getdocumentsb64exresponse ona l archman:documentsanddet ailsb64ex documentsanddetails List of archman:documentanddetailsb 64Ex archman:getdocumentsdetailsresponse strs:documentsanddetails List of strs:documentanddetails archman:getdocumentsresponse strs:documentsanddetails documentsanddetails documentsanddetails List of strs:documentanddetails found in the archive database

41 Data types 39 archman:getinternaldocumenttypesresponse strs:documentsanddetails List of strs:documentanddetails archman:getmetadatafordoctyperequest xsd:string documenttypeid Document type GUID archman:getmetadatafordoctyperesponse strs:documentsanddetails List of strs:documentanddetails archman:reprocessdocumentrequest xsd:string documentid Document GUID xsd:string channel Connector GUID X xsd:string reprocesstype print, fax or strs:arrayofmetadata channelinfo List of metadata that will be available as HTTP headers in the Project. All metadata defined for document is also available as HTTP headers.

42 40 Data types archman:searchcriteria strs:arrayofstrings documenttypeids List of document type GUIDs xsd:string creationdatetimeval ues Creation date time values. For example :00: :00: The string format is: yyyy-mm-dd hh:mm:ss[.fff]..yyyy-mm-dd hh:mm:ss[.fff] xsd:int startrow Row to start searching on row to start searching on, first row is 1. xsd:int maxnoofresults Maximum number of results to return xsd:int totalcount Total number of rows affected (out) X xsd:datetime searchtimestamp Time stamp of search. (in/out) X strs:arrayofmetadataex searchparams Metadata to search for strs:arrayofmetadataex outparams Metadata to return back in response xsd:string sortparam Metadata GUID to sort on xsd:string sortmode Sorting order ASC = Ascending DESC = Descending archman:updatedocumentmetadatatype xsd:string documentid Document ID of the document to update xsd:string metadataid Metadata ID of the metadata to update

43 Data types 41 xsd:string value The new metadata value

44 42 Data types

45 43 Appendix A - Status codes from web services HTTP responses This section provides a list of HTTP responses that may be received by the client. For a full list, please refer to the SOAP standard. Status Code 2xx Reason Phrase Significance/Action Next State Successful 200 OK The response message follows in the HTTP response entity body. Start making an abstraction of the response message available in soap/mep/ InboundMessage Sending+Receiving or Receiving 4xx Client Error 400 Bad Request Indicates a problem with the received HTTP request message. Sending+Receiving Receiving or Fail 405 Method not allowed Indicates that the peer HTTP server does not support the requested HTTP method at the given request URI. The message exchange is regarded as having completed unsuccessfully. Fail

46 44 Appendix A - Status codes from web services 415 Unsupported Media Type Indicates that the peer HTTP server does not support the content type used to encode the request message. The message exchange is regarded as having completed unsuccessfully. Fail 5xx Server Error 500 Internal Server Error Indicates a server problem or a problem with the received request. Sending+Receiving Receiving or Fail Table 1 HTTP status code dependent transitions SOAP responses This section provides a list of SOAP responses that might be received, based on incorrect SOAP requests. SOAP Fault HTTP Status Code HTTP Reason Phrase env:versionmismatch 500 Internal server error env:mustunderstand 500 Internal server error env:sender 400 Bad request env:receiver 500 Internal server error env:dataencodingunknown 500 Internal server error env:fault 500 See SOAP fault subcodes on page 45 Table 2 SOAP fault to HTTP status mapping

47 Appendix A - Status codes from web services 45 SOAP fault subcodes Fault code Message string 100 No document id:s were specified 101 Succeeded 102 Failed to prepare outgoing stream 103 No data found 104 Unable to get document content from database 105 No search criteria were specified in request 106 No sort criteria was specified in request 107 No outparams was specified in request 108 Failed to delete documents. <failed>/<total> documents failed 109 Failed to create documents. <failed>/<total> documents failed 110 Execution failed, probably due to a too generic search resulted in too many results 111 No document type name was specified 112 Failed to get metadata for document type <document type name> 113 No data was supplied in request 114 No document attachment was found in request 115 Invalid argument specified: <argname> 116 Failed to get document types 117 Successfully processed document: <document id> 118 Failed to process document: <document id> 119 Unable to find a channel for type <type> 120 No data was supplied in request 121 No reprocess type was specified 122 Unable to bind correspondence repository service 123 Failed to send the request to the preview channel <channel>: (<message> - <error code>) 124 Failed to retrieve archived data for document <document id> 125 Unknown protocol for channel <channel> specified 126 Unable to find any reprocess channel matching the requested reprocesstype <reprocess type>

48 46 Appendix A - Status codes from web services 127 Failed to create document annotation 128 Failed to get annotations for document <document id> 129 Failed to delete annotations 130 Failed to create document types 131 Document type definition syntax error: illegal type, character or length. id: <document type id>}, name: <document type name> 132 Failed to open document definition file 133 Failed to deserialize document definition file 134 Failed to update document metadata 135 No document type id:s were specified in request Table 3 SOAP fault subcodes