GetMessages

GetMessages

Filter inputs

Name

Type

Description

Mandatory

Available from version

Name

Type

Description

Mandatory

Available from version

BrickId

Guid[]

The BrickId (unique id) of the message

 

New method in 2.24

CreatedDate

DateTime

The date the message was created

 

 

Receivers

Guid[]

The user associated with the task

 

 

Subjects

string[]

The heading of the task

 

 

Bodies

string[]

The descriptive text of the task

 

 

IsRead

bool

If the message is read by the customer

 

 

IsPublic

bool

If the message is public

 

 

IsPromoted

bool

If the message is promoted

 

 

EventDateFrom

DateTime

The from-date of message

 

 

EventDateTo

DateTime

The to-date of message

 

 

IsHTML

bool

If the text contains html

 

 

Status

string[]

The status of the task, allowed values: "Created", "InProgress", "Done", "Closed"

 

 

Priority

string[]

The priority of the task, allowed values: "High", "Medium", "Low"

 

 

Response rows (Array) inherits from EntityBase

Name

Type

Description

Available from version

Name

Type

Description

Available from version

BrickId

Guid

The BrickId (unique id) of the task

 

CreatedDate

DateTime

The date the message was created

 

Receiver

Guid

The receiver of the message

 

Subject

string

The subject of the message

 

Body

string

The body of the message

 

EventDate

DateTime

The due date for message

 

IsRead

bool

If the message is read

 

IsPublic

bool

If the message is public

 

IsPromoted

bool

If the message is promoted

 

IsHTML

bool

If the body contains html

 

Status

string

The status of the message, allowed values: "Created", "InProgress", "Done", "Closed"

 

Priority

string

The priority of the message, allowed values: "High", "Medium", "Low"

 

Code examples

public static void GetActivityLogItemMessage() { var binding = new BasicHttpBinding(); binding.MaxReceivedMessageSize = Int32.MaxValue; var target = new bfsapi.bfsapiSoapClient(binding, new EndpointAddress("http://localhost:20010/bfsapi.asmx")); var req = new GetTasksRequest(); req.Credentials = new bfsapi.Credentials { UserName = GetApiUserName(), Password = GetApiPassword() }; req.identify = GetApiIdentifier(); req.Args=new GetMessagesArgs() { Status = new[] {"Done"} }; req.Fields=new GetMessagesFields() { Status = true }; var resp = target.GetMessages(req); }