Search
Root Documents DLL .Net Library (legacy) Consumer ConsumerRadarUpdateToXml

ConsumerRadarUpdateToXml

Updates radar related consumer's data (description, text color, text background color and border color) updating realtime radar too, returning the command's result in XML format.

public XmlDocument ConsumerRadarUpdateToXml(bool <byHttps>, string <userName>, string <password>, ConsumerRadarUpdateParameters <consumerRadarUpdateParameters>, ref char <messageType>, ref string <message>)

Parameters:

bool <byHttps> Set to true if you want to user https protocol otherwise, if you want to use http, set it to false
string <userName> A string containing the username assigned from MyWakes
string <password> A string containing the password for the MyWakes user
ConsumerRadarUpdateParameters <consumerRadarUpdateParameters> A ConsumerRadarUpdateParameters object containing command's specific parameters
ref char <messageType> A string containing output parameter that will return the type of message returned in <message> field: I=information, W=warning, E=error
ref string <message> A string containing output parameter with the message content

ConsumerRadarUpdateParameters

int <ConsumerId> Mandatory, is the id of the consumer to edit
string <RadarDescription> Optional, the new description that will appear in the radar for that consumer after radar refresh (if the value is empy the consumer's radar will show the CallSign as description). Note that if no value is set for this parameter this field will maintain the previous value.
string <RadarDescriptionColor> Optional, the new color of the description's text that will appear near the consumer's icon in the radar after its refresh. This is expressed in RRGGBB format. Note that if no value is set for this parameter this field will maintain the previous value.
string <RadarDescriptionBGColor> Optional, the new color of the description's background that will appear near the consumer's icon in the radar after its refresh. This is expressed in RRGGBB format. Note that if no value is set for this parameter this field will maintain the previous value.
string <RadarDescriptionBorderColor> Optional, the new color of the description's border that will appear near the consumer's icon in the radar after its refresh. This is expressed in RRGGBB format. Note that if no value is set for this parameter this field will maintain the previous value.

Returned Type: XmlDocument

Returns an XML Document with the following structure:

<?xml version="1.0" encoding="utf-8" ?> 
<furesult>
	<message><![CDATA[ OK ]]></message>
	<rowsUpdated>1</rowsUpdated>
</furesult>

 

Where

  • <message> contains OK or Error description
  • <rowsUpdated> if the command's result is OK this tag contains the number of the consumers successfully updated
Terms Of Use | Privacy Statement | Company info
  • © Cedac Sistemi srl
  • Head office: Via Toscana, 3 40035 Castiglione dei Pepoli (Italy) Tel.: +39 0534-93811 Fax: +39 0534-93899
  • Branch office: Via del Lavoro, 47 40033 Casalecchio di Reno (Italy)
  • Branch office: Via Parini, 1 40033 Casalecchio di Reno (Italy)
  • Share capital Euro 26,000.00 - Company Register of Bologna / VAT no / fiscal code 01695261204
MyWakes - Advanced GPS tracking system