Class GetDeedsByParamsRequest

Message sent to retrieve deeds under a specific journalized case by specified parameters

Inheritance

object

PlatinaMessageBase

GetDeedsByParamsRequest

Inherited Members

PlatinaMessageBase.UserName

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Namespace: Integration.MessageContracts.DeedManagement

Syntax

[MessageContract]
public class GetDeedsByParamsRequest : PlatinaMessageBase

Properties

Filters

Specifies filters.

Declaration

[MessageBodyMember]
public IList<PostListFilter> Filters { get; set; }

Property Value

Type	Description
IList<PostListFilter>	The filters for objects.

JournalizedCaseID

The unigue identifier of the journalized case.

Declaration

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

Property Value

Type	Description
int	[required] The unigue identifier of the journalized case.

OrderByField

Specifies field for ordering.

Declaration

[MessageBodyMember]
public GetDeedsByParamsRequest.OrderBy OrderByField { get; set; }

Property Value

Type	Description
GetDeedsByParamsRequest.OrderBy	The field for ordering

PageNumber

The page number of the list, in case there are several pages in the list.

Declaration

[MessageBodyMember]
public int PageNumber { get; set; }

Property Value

Type	Description
int	[required] The page number of the list, in case there are several pages in the list. The first page in the list has number 1.

Remarks

May be used by the consumer when paging through many pages.

RecordsPerPage

Specifies the number of objects to be returned per page by the system.

Declaration

[MessageBodyMember]
public int RecordsPerPage { get; set; }

Property Value

Type	Description
int	[required] Specifies the number of objects to be returned per page by the system.

SearchString

The value to search by specific fields.

Declaration

[MessageBodyMember]
public string SearchString { get; set; }

Property Value

Type	Description
string	The value to search by specific fields.

Remarks

Search is performed by title, deed type title and deed type identifier.

SortDirection

Specifies sort order direction.

Declaration

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

Property Value

Type	Description
SortDirection	The sort order direction.

Methods

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()