Class CreateWorkingDocumentRequest

A request message to be sent by consumer when crating a work document of a journalized case.

Inheritance

object

PlatinaMessageBase

CustomRequestHeaderMessageBase

CreateWorkingDocumentRequest

Implements

IDisposable

Inherited Members

CustomRequestHeaderMessageBase.CustomParameters

PlatinaMessageBase.UserName

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Namespace: Integration.MessageContracts.DocumentManagement

Syntax

[MessageContract]
public class CreateWorkingDocumentRequest : CustomRequestHeaderMessageBase, IDisposable

Properties

Description

The description of object.

Declaration

[MessageHeader]
public string Description { get; set; }

Property Value

Type	Description
string	The description of object.

DocumentTemplateID

The document template id of the document to be created.

Declaration

[MessageHeader]
public int DocumentTemplateID { get; set; }

Property Value

Type	Description
int	The document template id of the document to be created.

DocumentTypeID

The document type id of the document to be created.

Declaration

[MessageHeader]
public string DocumentTypeID { get; set; }

Property Value

Type	Description
string	The document type id of the document to be created.

Extension

The file extension of the document to be created.

Declaration

[MessageHeader]
public string Extension { get; set; }

Property Value

Type	Description
string	[required] The file extension of the document to be created.

Remarks

The extension should not include the ".".

FileContentLength

The length of the file content (in bytes) of the document to be created.

Declaration

[MessageHeader]
public long FileContentLength { get; set; }

Property Value

Type	Description
long	[required] The length of the file content (in bytes) of the document to be created.

JournalizedCaseID

The unique identifier of the journalized case to which the document belongs.

Declaration

[MessageHeader]
public int JournalizedCaseID { get; set; }

Property Value

Type	Description
int	[required] The unique identifier of the journalized case to which the document belongs.

Stream

The streamed bytes of the document to be created.

Declaration

[MessageBodyMember]
public Stream Stream { get; set; }

Property Value

Type	Description
Stream	[required] The streamed bytes of the document to be created.

Title

The title of the object.

Declaration

[MessageHeader]
public string Title { get; set; }

Property Value

Type	Description
string	The title of the object.

Methods

Dispose()

Dispose message

Declaration

public void Dispose()

IsValid()

Check if message request is valid.

Declaration

public override IsValidResult IsValid()

Returns

Type	Description
IsValidResult	IsValidResult containing an error message if invalid.

Overrides

PlatinaMessageBase.IsValid()

Implements

IDisposable