Interface IDocumentMangement
Methods for creating, updating, reading documents.
Namespace: Integration.ServiceContracts.DocumentManagement
Syntax
[ServiceContract(Namespace = "http://Formpipe.Integration.Services/PlatinaStandardAPI")]
public interface IDocumentMangementMethods
CreateDocumentFromTemplate(CreateDocumentFromTemplateRequest)
Creates a new document based on template and parent case.
Declaration
[OperationContract]
CreateDocumentFromTemplateResponse CreateDocumentFromTemplate(CreateDocumentFromTemplateRequest req)Parameters
| Type | Name | Description |
|---|---|---|
| CreateDocumentFromTemplateRequest | req | The request message. |
Returns
| Type | Description |
|---|---|
| CreateDocumentFromTemplateResponse | A message with the content of the document. |
Exceptions
| Type | Condition |
|---|---|
| FaultException |
CreateWorkingDocument(CreateWorkingDocumentRequest)
Creates a working document for a provided journalized case.
Declaration
[OperationContract]
NewWorkingDocumentResponse CreateWorkingDocument(CreateWorkingDocumentRequest newDoc)Parameters
| Type | Name | Description |
|---|---|---|
| CreateWorkingDocumentRequest | newDoc | The request message containing the document to be created, including any metadata |
Returns
| Type | Description |
|---|---|
| NewWorkingDocumentResponse | The response message of the created work document. |
DeleteWorkingDocument(DeleteWorkingDocumentRequest)
Deletes a work document from the system /soft delete
Declaration
[OperationContract]
DeleteWorkingDocumentResponse DeleteWorkingDocument(DeleteWorkingDocumentRequest req)Parameters
| Type | Name | Description |
|---|---|---|
| DeleteWorkingDocumentRequest | req | The request message identifying the work document to be deleted. |
Returns
| Type | Description |
|---|---|
| DeleteWorkingDocumentResponse | The response massage. |
Remarks
The system performs a soft delete.
GetDocumentTypesWithRelatedTemplates(GetDocumentTypesWithRelatedTemplatesRequest)
Gets the document types with related templates for specified case.
Declaration
[OperationContract]
GetDocumentTypesWithRelatedTemplatesResponse GetDocumentTypesWithRelatedTemplates(GetDocumentTypesWithRelatedTemplatesRequest req)Parameters
| Type | Name | Description |
|---|---|---|
| GetDocumentTypesWithRelatedTemplatesRequest | req | The request message identifying the case for which document types with related templates should be fetched. |
Returns
| Type | Description |
|---|---|
| GetDocumentTypesWithRelatedTemplatesResponse | The response massage containing the document types with related templates. |
GetWorkingDocument(GetWorkingDocumentRequest)
Gets a specific work document.
Declaration
[OperationContract]
GetWorkingDocumentResponse GetWorkingDocument(GetWorkingDocumentRequest req)Parameters
| Type | Name | Description |
|---|---|---|
| GetWorkingDocumentRequest | req | The request message for requesting a work document. |
Returns
| Type | Description |
|---|---|
| GetWorkingDocumentResponse | The message with metadata about the work document |
GetWorkingDocumentContent(GetWorkingDocumentContentRequest)
Retrieves the content of the work document, as a stream of bytes.
Declaration
[OperationContract]
GetWorkingDocumentContentResponse GetWorkingDocumentContent(GetWorkingDocumentContentRequest req)Parameters
| Type | Name | Description |
|---|---|---|
| GetWorkingDocumentContentRequest | req | The request message |
Returns
| Type | Description |
|---|---|
| GetWorkingDocumentContentResponse | A message with the content of the document. |
GetWorkingDocuments(GetWorkingDocumentsRequest)
Gets a list of work documents for a given journalized case.
Declaration
[OperationContract]
GetWorkingDocumentsResponse GetWorkingDocuments(GetWorkingDocumentsRequest req)Parameters
| Type | Name | Description |
|---|---|---|
| GetWorkingDocumentsRequest | req | The request message identifying the journalized case for which work documents should be fetched. |
Returns
| Type | Description |
|---|---|
| GetWorkingDocumentsResponse | The response massage containing the work documents. |
SearchDocuments(SearchDocumentsRequest)
Searches the specified documents by search request.
Declaration
[OperationContract]
SearchDocumentsResponse SearchDocuments(SearchDocumentsRequest request)Parameters
| Type | Name | Description |
|---|---|---|
| SearchDocumentsRequest | request | Search parameters and search options. |
Returns
| Type | Description |
|---|---|
| SearchDocumentsResponse | Search response with list of found documents and total number of found rows. |
UpdateWorkingDocument(UpdateWorkingDocumentRequest)
Updates metadata information associated with a provided work document.
Declaration
[OperationContract]
UpdateWorkingDocumentResponse UpdateWorkingDocument(UpdateWorkingDocumentRequest doc)Parameters
| Type | Name | Description |
|---|---|---|
| UpdateWorkingDocumentRequest | doc | The request message containing the metadata to be updated |
Returns
| Type | Description |
|---|---|
| UpdateWorkingDocumentResponse | A response message containing the result of the request. |
Remarks
All metadata must be (apart from the lists structures) must be provided in the request.