MobileCommMessagingService
First available in SystemsLink 2017.3.0.
Use MobileCommMessagingService to get, modify, remove, and update mobile communications.
Endpoint Address: [SystemsLinkRootUrl]/MobileCommMessagingService.svc
Methods
Append message
| Method Name | Parameters | C# return type | Description | |
|---|---|---|---|---|
Name |
C# data type |
|||
AppendMessageDates() |
id |
Guid |
void |
Add dates related to the message with the Guid id passed in. |
dates |
List<MobileCommMessageDate> |
|||
AppendMessageErrors() |
id |
Guid |
void |
Add errors related to the message with the Guid id passed in. |
errors |
List <MobileCommMessageUpdateError> |
|||
AppendMessageLinks() |
id |
Guid |
void |
Add related links to the message with the Guid id passed in. |
links |
List<MobileCommMessageLink> |
|||
Delete message
| Method Name | Parameters | C# return type | Description | |
|---|---|---|---|---|
Name |
C# data type |
|||
DeleteMessageByGuid() |
id |
Guid |
void |
Delete a mobile communication message using the Guid id provided. |
DeleteMessageDefinitionByExternalId() |
externalId |
string |
void |
Delete a mobile communication message definition using the external id provided. |
Get message
| Method Name | Parameters | C# return type | Description | |
|---|---|---|---|---|
Name |
C# data type |
|||
GetLast100MessageGuidsByDefinitionId() |
definitionId |
int |
List<Guid> |
Return the last 100 message Guids for the provided definitionId. |
GetLast100MessageIdByDefinitionId() |
definitionId |
int |
List <long> |
Return the last 100 message ids for the provided definitionId. |
GetMessageByGuid() |
id |
Guid |
MobileCommMessage |
Retrieve a mobile communication message object from the Guid id provided. |
GetMessageById() |
id |
long |
MobileCommMessage |
Retrieve a mobile communication message object from the id provided |
GetMessageDefinitionByExternalId() |
externalId |
string |
MobileCommMessageDefinition |
Retrieve a mobile communication message definition object from the externalId provided. |
GetMessageDefinitionById() |
id |
int |
MobileCommMessageDefinition |
Retrieve a mobile communication message definition object from the id provided. |
GetMessageDefinitionXML() |
def |
MobileCommMessageDefinition |
MobileCommMessageXML |
Return a mobile communication message definition and a definition XML. |
GetMessageMiddleTierProcessLog() |
messageId |
long |
List<MobileCommMessageMiddleTierProcessLog> |
Return a list of MiddleTier process logs for the given messageId. |
GetMessageProcessLog() |
messageId |
long |
List<MobileCommMessageProcessLog> |
Return a list of process logs for the given messageId. |
GetMessagesByLink() |
link |
MobileCommMessageLink |
List<MobileCommMessage> |
Return a list of all messages for the given link. |
GetMessagesByParentGuid() |
id |
Guid |
List<MobileCommMessageXML> |
Return all messages for a given parent message Guid. |
GetMessagesXMLByLink() |
link |
MobileCommMessageLink |
List<MobileCommMessageXML> |
Return a list of the xml and definition of a message for the given link. |
GetMessageXML() |
msg |
MobileCommMessage |
MobileCommMessageXML |
Return a message and its xml. |
def |
MobileCommMessageDefinition |
|||
GetMessageXMLByGuidId() |
id |
Guid |
MobileCommMessageXML |
Return the xml and message definition for the given message Guid id. |
Message process log
| Method Name | Parameters | C# return type | Description | |
|---|---|---|---|---|
Name |
C# data type |
|||
MessageProcessLogEnd() |
clientProcessingGuid |
Guid |
void |
Update the EndDate with current date on SQL server. |
messageGuid |
Guid |
|||
MessageProcessLogEndMiddleTier |
middleTierProcessingGuid |
Guid |
void |
Stamp the end date time on a MiddleTier process log. |
messageGuid |
Guid |
|||
MessageProcessLogStart() |
clientProcessingGuid |
Guid |
void |
Stamp the start date time on a new process log. |
messageGuid |
Guid |
|||
MessageProcessLogStartMiddleTier() |
middleTierProcessingGuid |
Guid |
void |
Stamp the start date time on a MiddleTier process log. |
clientProcessingGuid |
Guid |
|||
messageGuid |
Guid |
|||
method |
string |
|||
data |
string |
|||
Persist message
| Method Name | Parameters | C# return type | Description | |
|---|---|---|---|---|
Name |
C# data type |
|||
PersistMessageDates() |
id |
Guid |
void |
Update dates related to the message with the Guid id passed in. |
dates |
List<MobileCommMessageDate> |
|||
PersistMessageErrors() |
id |
Guid |
void |
Update errors related to the message with the Guid id passed in. |
errors |
List<MobileCommMessageUpdateError> |
|||
PersistMessageLinks() |
id |
Guid |
void |
Update links related to the message with the Guid id passed in. |
links |
List<MobileCommMessageLink> |
|||
Save message
| Method Name | Parameters | C# return type | Description | |
|---|---|---|---|---|
Name |
C# data type |
|||
SaveMessage() |
xml |
string |
MobileCommMessage |
Save a message from a raw message XML. |
links |
List<MobileCommMessageLinks> |
|||
dates |
List<MobileCommMessageDate> |
|||
direction |
DirectionEnum |
|||
messageGuid |
Guid |
|||
parentGuid |
Guid? |
|||
SaveRawMessageDefinition() |
xml |
string |
MobileCommMessageDefinition |
Save a raw message definition from XML. |
Properties and column mapping
MobileCommMessage
| Columns in Database column Name are from the MobileCommMessage database table. |
| Property | Database column | Comments | ||
|---|---|---|---|---|
Name |
C# data type |
Name |
Data type |
|
Dates |
List<MobileCommMessageDate> |
See below. |
||
Direction |
DirectionEnum |
DirectionId |
int, null |
|
Errors |
List<MobileCommMessageUpdateError> |
See below. |
||
ExternalId |
string |
ExternalId |
varchar(30), null |
|
Links |
List<MobileCommMessageLink> |
See below. |
||
MessageDefinitionId |
int? |
MessageDefinitionId |
int, null |
|
MessageGuid |
Guid |
MessageGuid |
uniqueidentifier, not null |
|
MessageId |
long |
MessageId |
bigint, not null |
|
Nodes |
List<MobileCommMessageNode> |
See below. |
||
ParentMessageId |
long? |
ParentMessageId |
bigint, null |
|
MobileCommMessageDate
| Columns in Database Column Name are from the MobileCommMessageDate database table. |
| Property | Database column | Comments | ||
|---|---|---|---|---|
Name |
C# data type |
Name |
Data type |
|
EventDate |
DateTimeOffset |
EventDate |
datetimeoffset, not null |
|
MessageDateId |
long |
MessageDateId |
bigint, not null |
|
MessageDateType |
DateTypeEnum |
MessageDateTypeId |
int, not null |
|
ModuleId |
ModuleTypeEnum |
ModuleId |
int, not null |
|
MobileCommMessageDefinition
| Columns in Database Column Name are from the MobileCommMessageDefinition database table. |
| Property | Database column | Comments | ||
|---|---|---|---|---|
Name |
C# data type |
Name |
Data type |
|
CreatedDate |
DateTime |
CreatedDate |
datetime, not null |
|
CreatedUser |
string |
CreatedUser |
varchar(200), not null |
|
Description |
string |
Description |
varchar(200), not null |
|
ExternalId |
string |
ExternalId |
varchar(200), not null |
|
MessageDefinitionId |
int |
MessageDefinitionId |
int, not null |
|
Name |
string |
Name |
varchar(200), not null |
|
Nodes |
List <MobileCommMessageNodeDefinition> |
|||
MobileCommMessageLink
Depending on the type, the links map to different database tables:
-
Check call: MobileCommMessageLinkCheckCall
-
Driver: MobileCommMessageLinkDriver
-
LegHeader: MobileCommMessageLinkLegHeader
-
Stop: MobileCommMessageLinkStop
-
Tractor: MobileCommMessageLinkTractor
-
Trailer: MobileCommMessageLinkTrailer
-
User: MobileCommMessageLinkUser
| Property | Database column | Comments | ||
|---|---|---|---|---|
Name |
C# data type |
Name |
Data type |
|
LinkId |
long |
|||
LinkType |
LinkTypeEnum |
|||
LinkValue |
string |
|||
MobileCommMessageMiddleTierProcessLog
| Columns in Database Column Name are from the MobileCommMessageMiddleTierProcessLog database table. |
| Property | Database column | Comments | ||
|---|---|---|---|---|
Name |
C# data type |
Name |
Data type |
|
EndDate |
DateTime? |
EndDate |
datetime, null |
|
MessageId |
long |
MessageId |
bigint, not null |
|
MiddleTierData |
string |
MiddleTierData |
varchar(max), not null |
|
MiddleTierMethod |
string |
MiddleTierMethod |
varchar(100), not null |
|
MiddleTierProcessLogGuid |
Guid |
MiddleTierProcessLogGuid |
uniqueidentifier, not null |
|
MiddleTierProcessProcessLogId |
long |
MiddleTierProcessProcessLogId |
bigint, not null |
|
ProcessLogId |
long |
ProcessLogId |
bigint, not null |
|
StartDate |
DateTime |
StartDate |
datetime, not null |
|
MobileCommMessageNode
| Columns in Database Column Name are from the MobileCommMessageNode database table. |
| Property | Database column | Comments | ||
|---|---|---|---|---|
Name |
C# data type |
Name |
Data type |
|
ChildContentId |
long? |
ChildContentId |
bigint, null |
|
NodeContentId |
long |
ChildContentId |
bigint, not null |
|
NodeDefinitionId |
int |
NodeDefinitionId |
int, not null |
|
ParentNodeContentId |
long? |
ParentNodeContentId |
bigint, null |
|
Properties |
List <MobileCommMessageNodeProperty> |
Not mapped to database. |
||
MobileCommMessageNodeDefinition
| Columns in Database Column Name are from the MobileCommMessageNodeDefinition database table. |
| Property | Database column | Comments | ||
|---|---|---|---|---|
Name |
C# data type |
Name |
Data type |
|
Expression |
string |
Expression |
varchar(max), null |
|
FriendlyName |
string |
FriendlyName |
varchar(200), null |
|
IsArray |
bool |
IsArray |
bit, not null |
|
Name |
string |
Name |
varcar(200), not null |
|
NodeDefinitionId |
int |
NodeDefinitionId |
int, not null |
|
ParentNodeDefinitionId |
int? |
ParentNodeDefinitionId |
int, null |
|
MobileCommMessageNodeProperty
| Columns in Database Column Name are from the MobileCommMessageNodeProperty database table. |
| Property | Database column | Comments | ||
|---|---|---|---|---|
Name |
C# data type |
Name |
Data type |
|
NodeContentId |
long |
NodeContentId |
bigint, not null |
|
PropertyContentId |
long |
PropertyContentId |
bigint, not null |
|
PropertyDefinitionId |
int |
PropertyDefinitionId |
int, not null |
|
Sequence |
long? |
Sequence |
bigint, null |
|
Value |
string |
Value |
varchar(max), not null |
|
MobileCommMessageNodePropertyDefinition
| Columns in Database Column Name are from the MobileCommMessageNodePropertyDefintion database table. |
| Property | Database column | Comments | ||
|---|---|---|---|---|
Name |
C# data type |
Name |
Data type |
|
DataType |
DataTypeEnum |
DataTypeId |
int, not null |
|
Description |
string |
Description |
varchar(200), null |
|
Expression |
string |
Expression |
varchar(max), null |
|
FriendlyName |
string |
FriendlyName |
varchar(200), null |
|
Name |
string |
Name |
varchar(200), not null |
|
NodeDefinitionId |
int |
NodeDefinition |
int, not null |
|
PropertyDefinitionId |
int |
PropertyDefinitionId |
int, not null |
|
MobileCommMessageProcessLog
| Columns in Database Column Name are from the MobileCommMessageProcessLog database table. |
| Property | Database column | Comments | ||
|---|---|---|---|---|
Name |
C# data type |
Name |
Data type |
|
EndDate |
DateTime? |
EndDate |
datetime, null |
|
MessageId |
long |
MessageId |
bigint, not null |
|
ProcessLogGuid |
Guid |
ProcessLogGuid |
uniqueidentifier, not null |
|
ProcessLogId |
long |
ProcessLogId |
bigint, not null |
|
StartDate |
DateTime |
StartDate |
datetime, not null |
|
MobileCommMessageUpdateError
| Columns in Database Column Name are from the MobileCommMessageUpdateError database table. |
| Property | Database column | Comments | ||
|---|---|---|---|---|
Name |
C# data type |
Name |
Data type |
|
ErrorDate |
DateTime? |
ErrorDate |
datetime, not null |
|
ErrorId |
long |
ErrorId |
bigint, not null |
|
ErrorMessage |
string |
ErrorMessage |
varchar(max), not null |
|
ErrorType |
string |
ErrorType |
varchar(100), null |
|
MessageId |
long |
MessageId |
bigint, not null |
|
PreventUpdate |
bool |
PreventUpdate |
bit, not null |
|
Source |
string |
Source |
varchar(50), null |
|
MobileCommMessageMessageXML
| Property | Database column | Comments | ||
|---|---|---|---|---|
Name |
C# data type |
Name |
Data type |
|
MessageDefinition |
MobileCommMessageDefinition |
No database mapping. Pulls XML from MobileCommMessage and MobileCommMessageDefinitios. |
||
MessageXML |
string |
No database mapping. Pulls XML from MobileCommMessage and MobileCommMessageDefinitios. |
||