NoteService

First available in SystemsLink 2017.3.0.

Create, delete, and retrieve notes with the NoteService. Add notes on profiles (master files) for information about a carrier, commodity, company, drive, tractor, trailer, etc. Use trip-related notes to convey information about billing, movements, orders, settlements, stops, etc. Use the IsUrgent property to mark the note as an Alert in TMWSuite applications.

Endpoint Address: [SystemsLinkRootUrl]/NoteService.svc

Methods

Method Name	Parameters	C# return type	Description
	Name	C# data type
Delete()	noteId	int	void	Delete Note specified by noteId.
Get()	noteKeys	List<NoteKey>	List<Note>	Retrieve a list of notes specified by noteKeys which occur in the interval of fromDate and toDate.
	fromDate	DateTime
	toDate	DateTime
NewItem()			Note	Create a new Note.
Save()	note	Note	Note	Save a Note.
Search()	filter	FilterObjectOfNote	PagedResultOfNote	Retrieve note data by filtering, sorting, and paging results.

Method Name

Parameters

C# return type

Description

Name

C# data type

Delete()

noteId

int

void

Delete Note specified by noteId.

Get()

noteKeys

List<NoteKey>

List<Note>

Retrieve a list of notes specified by noteKeys which occur in the interval of fromDate and toDate.

fromDate

DateTime

toDate

DateTime

NewItem()

Note

Create a new Note.

Save()

note

Note

Save a Note.

Search()

filter

FilterObjectOfNote

PagedResultOfNote

Retrieve note data by filtering, sorting, and paging results.

Note properties and column mapping

Columns in Database column Name are from the notes database table.

Property	Database table	Comments
Name	C# data type	Name	Data type
ControlData	string			Do not set. Read only. Not mapped.
CreatedBy	string			Read only. Not mapped.
CreatedDateTime	DateTime?			Read only. Not mapped.
ExpirationDate	DateTime?	not_expires	datetime	Date on which the note is no longer applicable.
FullNote	string	not_text_large	text(2147483647)	Used when the note exceeds the base note size of 254 characters.
IsUrgent	bool?	not_urgent	char(1)	Categorize the note as an Alert.
Key	string	nre_tablekey	char(18)	Table the note is associated with. For example, orderheader or stops.
NoteId	int	not_number	int	Unique identifier for the note.
NoteType	NoteTypeEnum	ntb_table	char(18)	See NoteTypeEnum.
NoteTypeAbbreviation	string	not_type	varchar(6)	Abbreviation associated with the note type labelfile entry.
RuleData	List<ConcurrencyFieldRule>			Read only. Not mapped.
SendToMobileComm	bool	not_tmsend	char(1)	Flag indicating a given note should be included in messages vial mobilecomm.
SentDate	DateTime?	not_senton	datetime	Date and time note was sent.
Sequence	short	not_sequence	smallint	Order of the note in a set of notes.
ShortNote	string	not_text	varchar(254)	Base note. Works in conjunction with FullNote.
UpdateDateTime	DateTime?	last_updatedatetime	datetime	Read only. Not mapped.
UpdatedBy	string	lsat_updatedby	char(20)	Read only. Not mapped.
ViewLevel	string	not_viewlevel	varchar(6)

Property

Database table

Comments

Name

C# data type

Name

Data type

ControlData

string

Do not set. Read only. Not mapped.

CreatedBy

string

Read only. Not mapped.

CreatedDateTime

DateTime?

Read only. Not mapped.

ExpirationDate

DateTime?

not_expires

datetime

Date on which the note is no longer applicable.

FullNote

string

not_text_large

text(2147483647)

Used when the note exceeds the base note size of 254 characters.

IsUrgent

bool?

not_urgent

char(1)

Categorize the note as an Alert.

Key

string

nre_tablekey

char(18)

Table the note is associated with. For example, orderheader or stops.

NoteId

int

not_number

int

Unique identifier for the note.

NoteType

NoteTypeEnum

ntb_table

char(18)

See NoteTypeEnum.

NoteTypeAbbreviation

string

not_type

varchar(6)

Abbreviation associated with the note type labelfile entry.

RuleData

List<ConcurrencyFieldRule>

Read only. Not mapped.

SendToMobileComm

bool

not_tmsend

char(1)

Flag indicating a given note should be included in messages vial mobilecomm.

SentDate

DateTime?

not_senton

datetime

Date and time note was sent.

Sequence

short

not_sequence

smallint

Order of the note in a set of notes.

ShortNote

string

not_text

varchar(254)

Base note. Works in conjunction with FullNote.

UpdateDateTime

DateTime?

last_updatedatetime

datetime

Read only. Not mapped.

UpdatedBy

string

lsat_updatedby

char(20)

Read only. Not mapped.

ViewLevel

string

not_viewlevel

varchar(6)

NoteKey properties

Property	Comments
Name	C# data type
Key	string	Primary key index for the note table type. For example, if the note is associated with the stop table, the key would be the stop number.
NoteType	NoteTypeEnum	See NoteTypeEnum.

Property

Comments

Name

C# data type

Key

string

Primary key index for the note table type. For example, if the note is associated with the stop table, the key would be the stop number.

NoteType

NoteTypeEnum

See NoteTypeEnum.

NoteTypeEnum members and properties

Members	Comments
Carrier	Represents carrier.
Commodity	Represents commodity.
Company	Represents company.
Driver	Represents manpowerprofile.
Move	Represents movement.
Order	Represents orderheader.
Stop	Represents stops.
ThirdParty	Represents thirdpartyprofile.
Tractor	Represents tractorprofile.
Trailer	Represents trailerprofile.

Members

Comments

Carrier

Represents carrier.

Commodity

Represents commodity.

Company

Represents company.

Driver

Represents manpowerprofile.

Move

Represents movement.

Order

Represents orderheader.

Stop

Represents stops.

ThirdParty

Represents thirdpartyprofile.

Tractor

Represents tractorprofile.

Trailer

Represents trailerprofile.