Home  |  Products  |  Download  |  Purchase  |  Support  |  Login  

MiniPoint Server API

This section describes the Application Programing Interface available to access MiniPoint from the Messaging component MPLib.dll.

Some of the functions are avaliable as WEB services through the MiniPoint TCP or HTTP Port.

For demonstration of the Component API, see Component API Demo.

For demonstration of the Web API, see Web API Demo.


Methods

MiniPoint Server Access
LoginCheck users access to MiniPoint server.
LogoutClear login.
SetUserSet user login details as an alternative to Login.

Send Messages and Data
SendNoteSend MiniNote Message.
SendMsgSend MiniNote Message using default settings.
SendAlarmSend MiniNote Message using alarm settings.
SendReminderSend MiniNote as a reminder.
SendChannelDataSend data to MiniPoint Channel.
SendLinkSend link to document or URL.
SendSmsSend SMS message to cellular phone.
SendMailSend EMail message.
SendSmsDirectSend SMS message directly using WEB Service.
SendMailDirectSend EMail directly using SMTP.
SendDataSend MiniPoint data message (low level format).

Get Messages and Data
GetUndeliveredNotesGet undelivered MiniNote Messages.
GetChannelDataGet MiniPoint Channel data.
GetFileGet file from MiniPoint Web folder (limited size).
GetUsersGet matching MiniPoint users.
GetGroupsGet matching MiniPoint groups.
GetChannelsGet matching MiniPoint channels.
GetActiveUsersGet users loged on to MiniPoint.
GetActiveChannelUsersGet users connected to MiniPoint Channel.
GetGroupMembersGet members of a MiniPoint group.
GetUserGroupsGet joined groups for a user.
RequestDataRequest MiniPoint data (low level format).

Database Operations
SelectDataSelect single row of data from MiniPoint server.
InsertDataInsert new row of data.
UpdateDataUpdate single row of data.
DeleteDataDelete single row of data.

Compose Messages
EncodeNoteCreate MiniNote message as text string.
EncodeLinkCreate Link message as text string.
EncodeUserCreate User message as text string.
EncodeGroupCreate Group message as text string.
EncodeChannelCreate Channel message as text string.
GetColorFormat Color parameter.
GetFontAttrFormat font attribute parameter.
GetTimeFormat time parameter.

Add New Items
AddUserAdd MiniPoint User.
AddGroupAdd MiniPoint Group.
AddChannelAdd MiniPoint Channel.

Other Functions
ReInitRead configuration parameters from configuration file.
SetFileModeSend messages by writing to file read by MiniPoint server.
SetDirectModeSend EMail and SMS messages directly to configured server.
SetNormalModeSend messages to MiniPoint server.
GetConfigGet configuration parameters as text string.
TransmitSend and receive MiniPoint data (low level format).



Properties

UserIdUser Id of active user (set on successful login).
UserNameUser Name of active user.
PasswordPassword.
FullNameFull Name (set on successful login).
AliasAlias (set on successful login).
EMailEMail address (set on successful login).
MobileNoMobile number for SMS messages (set on successful login).



Login

Check login

ParameterDescriptionTypeIn/Out
UserNameUser name of user to checkStringIn
PasswordPassword of user to checkStringIn
ReturnUser Id of user. 0 if password wrong or user not existsString 

Logout

Clear last login

ParameterDescriptionTypeIn/Out
Return1Integer 

SetUser

Set user login details as an alternative to login

ParameterDescriptionTypeIn/Out
UserNameUser nameStringIn
PasswordPasswordStringIn
FullNameFull nameStringIn
AliasAliasStringIn
EMailE-Mail addressStringIn
MobileNoUsers cellular phone noStringIn
Return1Integer 

SendNote

Send MiniNote message.

ParameterDescriptionTypeIn/Out
ToReceivers full name or user nameStringIn
TextText of messageStringIn
XX Position of message windowLongIn
YY Position of message windowLongIn
WWidth of message windowLongIn
HHeight of message windowLongIn
FGColorForeground color. Use GetColor to convert RGB valueLongIn
BGColorBackground color. Use GetColor to convert RGB valueLongIn
FontSizeFont SizeLongIn
FontAttrFont Attribute. Use GetFontAttr to get formated valueLongIn
FontNameFont NameStringIn
ReturnLength of message sentInteger 

SendMsg

Send MiniNote message using default settings.

ParameterDescriptionTypeIn/Out
ToReceivers full name or user nameStringIn
TextText of messageStringIn
ReturnLength of message sentInteger 

SendAlarm

Send MiniNote as an Alarm message using alarm settings.

ParameterDescriptionTypeIn/Out
ToReceivers full name or user nameStringIn
TextText of messageStringIn
ReturnLength of message sentInteger 

SendReminder

Send MiniNote as a reminder.

ParameterDescriptionTypeIn/Out
ToReceivers full name or user nameStringIn
MessageMessage. Use eg. EncodeNote to form messageStringIn
TimeTime to show. Use GetTime to get proper formated valueStringIn
DurationDuration in seconds, if timespan wantedStringIn
IntervalInterval to repeat message. See below for valid valuesStringIn
ReturnLength of message sentInteger 

Valid values for interval:
0: No interval, just show once
1: Show every minute
2: Show every hour
3: Show every day
4: Show every week day (not yet implemented)
5: Show every week
6: Show every month
7: Show every day in month (not yet implemented)
8: Show every year


SendChannelData

Send data on MiniPoint Channel

ParameterDescriptionTypeIn/Out
ChannelIdChannel IdStringIn
TextText of messageStringIn
ReturnLength of message sentInteger 

Send link to document or URL

ParameterDescriptionTypeIn/Out
ToReceivers full name or user nameStringIn
TextText of messageStringIn
LinkDocument link or URLStringIn
ReturnLength of message sentInteger 

SendSms

Send SMS message to cellular phone

ParameterDescriptionTypeIn/Out
ToReceivers cellular phone numberStringIn
TextText of messageStringIn
ReturnLength of message sentInteger 

SendMail

Send Mail message

ParameterDescriptionTypeIn/Out
ToReceivers E-Mail addressStringIn
SubjectSubject of messageStringIn
TextText of messageStringIn
ReturnLength of message sentInteger 

SendSmsDircet

Send SMS to cellular phone directly using WEB service

ParameterDescriptionTypeIn/Out
ToReceivers cellular phone numberStringIn
TextText of messageStringIn
ReturnLength of message sentInteger 

SendMailDirect

Send Mail directly using SMTP

ParameterDescriptionTypeIn/Out
ToReceivers E-Mail addressStringIn
SubjectSubject of messageStringIn
TextText of messageStringIn
ReturnLength of message sentInteger 

SendData

Send data message (MiniPoint format)

ParameterDescriptionTypeIn/Out
DataMiniPoint data messageStringIn
ReturnLength of message sentInteger 

GetUndeliveredNotes

Get undelivered MiniNote messages

ParameterDescriptionTypeIn/Out
ReturnMessages (HTML formated)String 

GetChannelData

Get MiniPoint Channel data

ParameterDescriptionTypeIn/Out
ChannelIdChannel IdIntegerIn
ReturnMessages (HTML formated)String 

GetFile

Get file from MiniPoint Web folder (limited size)

ParameterDescriptionTypeIn/Out
FileNameFile NameStringIn
ReturnMessages (HTML formated)String 

GetUsers

Get users from server

ParameterDescriptionTypeIn/Out
RequestPart of user name to match (empty string for all)StringIn
ReturnUsers matching requestString 

GetGroups

Get groups from server

ParameterDescriptionTypeIn/Out
RequestPart of group name to match (empty string for all)StringIn
ReturnGroups matching requestString 

GetChannels

Get channels from server

ParameterDescriptionTypeIn/Out
RequestPart of channel name to match (empty string for all)StringIn
ReturnChannels matching requestString 

GetActiveUsers

Get active users on server

ParameterDescriptionTypeIn/Out
RequestPart of user name to match (empty string for all)StringIn
ReturnUsers matching requestString 

GetActiveChannelUsers

Get users who are active on a channel

ParameterDescriptionTypeIn/Out
RequestPart of user name to match (empty string for all)StringIn
ReturnUsers matching requestString 

GetGroupMemebers

Get members of a group

ParameterDescriptionTypeIn/Out
GroupNameName of groupStringIn
ReturnMembers in groupString 

GetUserGroups

Get a users joined groups

ParameterDescriptionTypeIn/Out
UserNameName of userStringIn
ReturnGroups which user is member ofString 

RequestData

Request MiniPoint data (low level format)

ParameterDescriptionTypeIn/Out
RequestMiniPoint request messageStringIn
ReturnReply to messageString 

SelectData

Select single row of data from MiniPoint server

ParameterDescriptionTypeIn/Out
DataData to matchStringIn
ReturnReply to messageString 

InsertData

Insert new row of data

ParameterDescriptionTypeIn/Out
DataData to matchStringIn
ReturnReply to messageString 

UpdateData

Update single row of data

ParameterDescriptionTypeIn/Out
DataData to matchStringIn
ReturnReply to messageString 

DeleteData

Delete single row of data

ParameterDescriptionTypeIn/Out
DataData to matchStringIn
ReturnReply to messageString 

EncodeNote

Create MiniNote message as text string

ParameterDescriptionTypeIn/Out
ToReceivers full name or user nameStringIn
TextText of messageStringIn
XX Position of message windowLongIn
YY Position of message windowLongIn
WWidth of message windowLongIn
HHeight of message windowLongIn
FGColorForeground color. Use GetColor to convert RGB valueLongIn
BGColorBackground color. Use GetColor to convert RGB valueLongIn
FontSizeFont SizeLongIn
FontAttrFont Attribute. Use GetFontAttr to get formated valueLongIn
FontNameFont NameStringIn
ReturnMessageString 

Create Link message as text string

ParameterDescriptionTypeIn/Out
ToReceivers full name or user nameStringIn
TextText of messageStringIn
LinkDocument link or URLStringIn
ReturnMessageString 

EncodeUser

Create User message as text string

ParameterDescriptionTypeIn/Out
UserIdUser IdUnsigned LongIn
UserNameUser NameStringIn
FullNameFull NameStringIn
AliasAliasStringIn
GroupDefault groupStringIn
DepartmentDepartmentStringIn
CompanyCompanyStringIn
PasswordUser PasswordStringIn
EMailEMail addressStringIn
AllowEMailAllow send to users email accountIntegerIn
MobileNoCellular phone numberStringIn
AllowMobileAllow send to users cellular phoneIntegerIn
PdaAddress of PDAStringIn
AllowPdaAllow send to PDAIntegerIn
ProtectProtect User from loginIntegerIn
ISAdminUser has administrator privilegesIntegerIn
ReturnMessageString 

EncodeGroup

Create Group message as text string

ParameterDescriptionTypeIn/Out
GroupIdGroup IdUnsigned LongIn
GroupNameGroup NameStringIn
DescriptionDescriptionStringIn
ReturnMessageString 

EncodeChannel

Create Channel message as text string

ParameterDescriptionTypeIn/Out
ChannelIdChannel IdUnsigned LongIn
ChannelNameChannel NameStringIn
NoLinesNumber of linesIntegerIn
LineLengthMaximum length of linesIntegerIn
ProtectProtect channel, group membership requiredIntegerIn
AutoAutomatic startup of channelIntegerIn
DescriptionDescriptionStringIn
GroupGroup allowed for protected channelsStringIn
AllowMobileAllow messages to be sent remoteIntegerIn
AuthorUser or group with write privileges for read only channelsStringIn
ReturnMessageString 

GetColor

Format Color parameter

ParameterDescriptionTypeIn/Out
RedRed value (0-255)IntegerIn
GreenGreen value (0-255)IntegerIn
BlueBlue value (0-255)IntegerIn
ReturnMessageString 

GetFontAttr

Format font attribute parameter

ParameterDescriptionTypeIn/Out
BoldBold (0-1)IntegerIn
ItalicItalic (0-1)IntegerIn
UnderlineUnderline (0-1)IntegerIn
StrikeoutStrikeout (0-1)IntegerIn
ReturnMessageString 

GetTime

Format time parameter

ParameterDescriptionTypeIn/Out
YearYear (4 digits)IntegerIn
MonthMonth (1-12)IntegerIn
DayDay (1-31)IntegerIn
HourHour (1-24)IntegerIn
MinuteMinute (1-60)IntegerIn
SecondsSeconds (1-60)IntegerIn
ReturnMessageString 

AddUser

Add new User

ParameterDescriptionTypeIn/Out
UserNameUser NameStringIn
PasswordUser PasswordStringIn
FullNameFull NameStringIn
AliasAliasStringIn
DepartmentDepartmentStringIn
CompanyCompanyStringIn
EMailEMail addressStringIn
MobileNoCellular phone numberStringIn
ReturnResult (>0 if ok)Integer 

Not all members can be set using AddUser. To set other members, use the methods EncodeUser and InsertData.


AddGroup

Add new Group

ParameterDescriptionTypeIn/Out
GroupNameGroup NameStringIn
DescriptionDescriptionStringIn
ReturnResult (>0 if ok)Integer 

AddChannel

Add new Channel

ParameterDescriptionTypeIn/Out
ChannelNameChannel NameStringIn
DescriptionDescriptionStringIn
NoLinesNumber of linesIntegerIn
LineLengthMaximum length of linesIntegerIn
ProtectProtect channel, group membership requiredIntegerIn
AutoAutomatic startup of channelIntegerIn
GroupGroup allowed for protected channelsStringIn
AllowMobileAllow messages to be sent remoteIntegerIn
AuthorUser or group with write privileges for read only channelsStringIn
ReturnResult (>0 if ok)Integer 

ReInit

Reset and read configuration parameters

ParameterDescriptionTypeIn/Out
Return1Integer 

SetNormalMode

Messages will be sent to MiniPoint server

ParameterDescriptionTypeIn/Out
Return1Integer 

SetDirectMode

SMS and Mail messages will be sent directly using WEB service and SMTP

ParameterDescriptionTypeIn/Out
Return1Integer 

SetFileMode

Messages will be saved to file

ParameterDescriptionTypeIn/Out
Return1Integer 

GetConfig

Get Configuration parameters as text

ParameterDescriptionTypeIn/Out
ReturnConfiguration settingsString 

Transmit

Send and receive raw message (MiniPoint format with header)

ParameterDescriptionTypeIn/Out
DataData to sendBinaryIn
LengthLength of data to sendIntegerIn
ReturnData receivedBinary 

 
© 2009 MiniPoint®. All rights reserved.