SMS

StartServer

This XML starts the SMS.

Input Parameter description	View sample InputXml
Output Parameter description	View sample OutputXml

Input XML

Name	Parent Tag	Description	Valid Values
AdminOption	Root	Unique option for the call.	StartServer

Output XML

Name	Parent Tag	Description
AdminOption	Root	Unique option for the call.
Status	Root	Status of the call. If it is 0, then the call is successful.

StopServer

This XML stops the SMS.

Input Parameter description	View sample InputXml
Output Parameter description	View sample OutputXml

Input XML

Name	Parent Tag	Description	Valid Values
AdminOption	Root	Unique option for the call.	StopServer

Output XML

Name	Parent Tag	Description
AdminOption	Root	Unique option for the call.
Status	Root	Status of the call. If it is 0, then the call is successful.

SetServerProperty

This XML sets the SMS properties to those specified in the input XML.

Input Parameter description	View sample InputXml
Output Parameter description	View sample OutputXml

Input XML

Name	Parent Tag	Description	Valid Values
AdminOption	Root	Unique option for the call.	SetServerProperty
ServerIni	Root	Contains entries of the configuration files.
Port	ServerIni	Port on which the SMS will listen.	Any Integer>0
ClientList	Root	List of clients that have to be disconnected. This needs to be sent only when some clients have to be disconnected.
Client	ClientList	Information about the client that has to be disconnected.
ClientId	Client	Id of the client who is connected to the SMS.	Any Integer.
ClientIPAddress	Client	IP address of the machine from which the client is connected to SMS.	Any valid IP address.
Operation	Client	The operation to be performed.	D – disconnect client from SMS.
LabelList	Root	contains the list of labels that are to be added, deleted or modified.
Label	LabelList	The label that has to be added, deleted or modified.
Operation	Label	The operation to be performed.	A – Add label R - Remove label M- Modify label.
LabelName	Label	Name of the label on which the operation has to be performed.	Any valid string.
LabelPath	Label	The physical where the data of that particular label would be stored. This option is to be sent only when Operation is either R or M.	Any valid storage path.
CreateDirFlag	Label	Creates the directories in the path specified by the LabelPath if they do not exist. This option is to be sent only when Operation is either R or M.	Y – yes N – no

Output XML

Name	Parent Tag	Description
AdminOption	Root	Unique option for the call.
Status	Root	Status of the call. If it is 0, then the call is successful.

GetServerProperty

This XML Fetches the SMS properties (Server Configuration, Client Info, History info, Label Info)

Input Parameter description	View sample InputXml
Output Parameter description	View sample OutputXml

Input XML

Name	Parent Tag	Description	Valid Values
AdminOption	Root	Unique option for the call.	GetServerProperty
Flag	Root	This flag specifies the properties that are to be fetched. Its value is a four-digit integer (eg. 1011). If the first digit is 1 server configuration is fetched. If the second digit is 1 then the Client Information is fetched. If the third digit is 1 then Client History Information is fetched. If the fourth digit is 1 then SMS volume Information is fetched.	A four-digit string where each digit can be either 0 or 1.
ServerIni	Root	Contains entries of the configuration files.
Port	ServerIni	Port on which the SMS will listen.	Any Integer>0
ClientList	Root	List of clients that have to be disconnected. This needs to be sent only when some clients have to be disconnected.
Client	ClientList	Information about the client that has to be disconnected.
ClientId	Client	Id of the client who is connected to the SMS.	Any Integer.
ClientIPAddress	Client	IP address of the machine from which the client is connected to SMS.	Any valid IP address.
Operation	Client	The operation to be performed.	D – disconnect client from SMS.
LabelList	Root	contains the list of labels that are to be added, deleted or modified.
Label	LabelList	The label that has to be added, deleted or modified.
Operation	Label	The operation to be performed.	A – Add label R - Remove label M- Modify label.
LabelName	Label	Name of the label on which the operation has to be performed.	Any valid string.
LabelPath	Label	The physical where the data of that particular label would be stored. This option is to be sent only when Operation is either R or M.	Any valid storage path.
CreateDirFlag	Label	Creates the directories in the path specified by the LabelPath if they do not exist. This option is to be sent only when Operation is either R or M.	Y – yes N – no

Output XML

Name	Parent Tag	Description
AdminOption	Root	Unique option for the call.
ServerStatus	Root	Contains the information about the status of SMS.
Status	ServerStatus	Status of the server. It Can be either “ Running” or “Idle”.
Port	ServerStatus	Port on which the SMS is running.
NoOfLabels	ServerStatus	Number of labels that have been created.
NoOfUsers	ServerStatus	The number of users that are connected to the SMS.
TimeSinceStarted	ServerStatus	Time since the SMS was last started.
ClientList	Root	List of clients that are connected to the SMS.
Client	ClientList	Information about the client connected to the SMS.
Id	Client	Id of the Client connected to the SMS.
Location	Client	Host name and IP address of the machine from which the client is connected to the SMS returned as <Host Name> (<IP Address>)
ConnectedAt	Client	The time at which the client was connected to the SMS.
LastRequestAt	Client	The time at which the client sent the last request to SMS.
Status	Client	Indicates whether the client is performing some operation or not. Its value is “Idle” if client is not executing any operation otherwise it is “Running”.
HistoryList	Root	List of last forty disconnected users.
Client	HistoryList	Information about the client.
Id	Client	Id of the client that was connected.
Location	Client	IP of the machine from which the client connected to the SMS.
ConnectedAt	Client	Time at which the client connected to the SMS.
DisconnectedAt	Client	Time at which the client disconnected from the SMS.
DisconnectedType	Client	Manner in which the client disconnected from SMS. It’s value can be “Normal” – client disconnected normally. “Abrupt” – client was disconnected abruptly due to system error. “Admin Forced” – The client was forcefully disconnected by the administrator.
LabelList	Root	List of labels.
Label	LabelList	Information about a particular label.
LabelName	Label	Name of the label.
Path	Label	The path on a physical device where the documents of this label are stored.
Created	Label	The date and time on which this label was created.
LastAccessed	Label	The date and time when this label was accessed last.
SpaceUsed	Label	The space in bytes that is being used by this label.