DispatchedMessageService
First available in SystemsLink 2017.3.0.
Use DispatchedMessageService to add, retrieve, and delete mobile communication messages, such as text messages and load assignments, sent to driver units.
Endpoint Address: [SystemsLinkRootUrl]/DispatchedMessageService.svc
Methods
| Method Name | Parameters | C# return type | Description | |
|---|---|---|---|---|
Name |
C# data type |
|||
Add() |
message |
List<dispatchedmessage> |
void |
Add the specified messages. |
DeleteMessage() |
messageId |
int |
void |
Delete the message. |
GetCancelLoadAssignment() |
Get the cancel load assignment. |
|||
GetCancelLoadAssignmentForMessageGroup() |
messageGroup |
int |
Get the cancel load assignment for message group. |
|
GetCancelLoadAssignments() |
List<CancelLoadAssignment> |
Get the cancel load assignments. |
||
GetCancelLoadAssignmentsForMessageGroup() |
messageGroup |
int |
List<CancelLoadAssignment> |
Get the cancel load assignments for message group. |
GetDispatchedMessage() |
messageGroup |
int |
Get the dispatched message. |
|
applicationName |
string |
|||
GetLoadAssignment() |
Get the load assignment. |
|||
GetLoadAssignmentForMessageGroup() |
messageGroup |
int |
Get the load assignment for message group. |
|
GetLoadAssignments() |
List <LoadAssignment> |
Get the load assignments. |
||
GetLoadAssignmentsForMessageGroup() |
messageGroup |
int |
List<LoadAssignment> |
Get the load assignments for message group. |
GetTextMessage() |
Get the text message. |
|||
GetTextMessageForMessageGroup() |
messageGroup |
int |
Get the text message for message group. |
|
GetTextMessages() |
List<TextMessage> |
Get the text messages. |
||
GetTextMessagesForMessageGroup() |
messageGroup |
int |
List<TextMessage> |
Get the text messages for message group. |
CancelLoadAssignment properties
| Property | Database table | Comments | ||
|---|---|---|---|---|
Name |
C# data type |
Name |
Data type |
|
From |
string |
msg_From |
varchar(100) |
Name of person or entity sending message. Mapped to MobileCommMessageQueue . |
LegNumber |
int |
msd_FieldValue |
varchar(254) |
This is the value of the legnumber if msd_FieldName = LGH_NUMBER. Mapped to MobileCommMessageQueueFields. |
MessageId |
int |
msg_ID |
int |
Unique message ID. Mapped to MobileCommMessageQueue. |
To |
string |
msg_To |
varchar(100) |
Message recipient. Mapped to MobileCommMessageQueue. |
DispatchedMessage properties and column mapping
| Columns in Database Column Name are from the MobileCommMessageQueue database table. |
| Property | Database column | Comments | ||
|---|---|---|---|---|
Name |
C# data type |
Name |
Data type |
|
ApplicationName |
string |
ApplicationName |
var(256) |
Name of the application. |
CreateDate |
DateTime |
msg_date |
datetime |
Date created. |
DelaySeconds |
int |
msg_FilterDataDupWaitSeconds |
int |
The time in seconds to wait. |
FilterData |
string |
msg_FilterData |
varchar(254) |
Message filtering data. |
FormId |
int |
msg_FormID |
int |
Unique form ID. |
From |
string |
msg_From |
varchar(100) |
Name of person or entity sending message. |
FromType |
int |
msg_FromType |
int |
Type of message sender. |
MessageFields |
List <DispatchedMessageField> |
Not mapped. See DispatchedMessageField. |
||
MessageGroup |
int |
MessageGroup |
int |
Outbound message group. |
MessageId |
int |
msg_ID |
int |
Unique message ID. |
RetrievedDate |
DateTime? |
RetrievedDate |
datetime2 |
Date and time message retrieved. |
Subject |
string |
msg_Subject |
varchar(254) |
Message subject. |
To |
string |
msg_To |
varchar(100) |
Message recipient. |
ToType |
int |
msg_ToType |
int |
Addressee type. |
DispatchedMessageField properties and column mapping
| Columns in Database column Name are from the TMSQLMessageData database table. |
| Property | Database column | Comments | ||
|---|---|---|---|---|
Name |
C# data type |
Name |
Data type |
|
FieldName |
string |
msd_FieldName |
varchar(30) |
Name of field. |
FieldValue |
string |
msd_FieldValue |
varchar(254) |
Value of field. |
MessageFieldId |
id |
msd_ID |
int |
Message field identifier. |
Sequence |
id |
msd_Seq |
int |
Field sequence. |
LoadAssignment properties and column mapping
| Property | Database column | Comments | ||
|---|---|---|---|---|
Name |
C# data type |
Name |
Data type |
|
From |
string |
msg_From |
varchar(100) |
Name of person or entity sending message. Mapped to MobileCommMessageQueue . |
LegNumber |
int |
msd_FieldValue |
varchar(254) |
This is the value of the legnumber if msd_FieldName = LGH_NUMBER. Mapped to MobileCommMessageQueueFields. |
MessageId |
int |
msg_ID |
int |
Unique message ID. Mapped to MobileCommMessageQueue. |
To |
string |
msg_To |
varchar(100) |
Message recipient. Mapped to MobileCommMessageQueue. |
TextMessage properties and column mapping
| Property | Database column | Comments | ||
|---|---|---|---|---|
Name |
C# data type |
Name |
Data type |
|
From |
string |
msg_From |
varchar(100) |
Name of person or entity sending message. Mapped to MobileCommMessageQueue . |
Message |
string |
|||
MessageId |
int |
msg_ID |
int |
Unique message ID. Mapped to MobileCommMessageQueue. |
To |
string |
msg_To |
varchar(100) |
Message recipient. Mapped to MobileCommMessageQueue. |
Subject |
string |
Message subject. Mapped to MobileCommMessageQueue. |
||
ToType |
DispatchedMessageAddressingTypeEnum |
Addressee type. Mapped to MobileCommMessageQueue. |
||
DispatchedMessageAddressingTypeEnum properties
| Members | Comments |
|---|---|
Alias |
Represents the DispatchedMessageAddressingType of Alias. The object is a TotalMail Alias Name. |
AutoResolve |
Represents the DispatchedMessageAddressingType of AutoResolve. TotalMail will try to determine on its own what type of object the send is to. |
Defunct |
Represents the DispatchedMessageAddressingType of Defunct. This type should no longer be used. |
DispatchGroup |
Represents the DispatchedMessageAddressingType of DispatchGroup. The object is a TotalMail DispatchGroup. |
DispatchSystemDriverID |
Represents the DispatchedMessageAddressingType of DispatchSystemDriverID. The object is a Driver ID for the Dispatch System that TotalMail is connected to. |
DispatchSystemTruckID |
Represents the DispatchedMessageAddressingType of DispatchSystemTruckID. The object is a Truck ID for the Dispatch System that TotalMail is connected to. |
Driver |
Represents the DispatchedMessageAddressingType of Driver. The object is a TotalMail Driver Name. |
External |
Represents the DispatchedMessageAddressingType of External. The object is an addressee outside of TotalMail (internet or MAPI email address). |
Login |
Represents the DispatchedMessageAddressingType of Login. The object is a TotalMail Login. |
McUnit |
Represents the DispatchedMessageAddressingType of McUnit. The object is a TotalMail CabUnit ID. |
Truck |
Represents the DispatchedMessageAddressingType of Truck. The object is a TotalMail Truck or Truck Group Name. |