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

ConsumerCreateToXml

Creates a new consumer returning command's result in Xml format

public XmlDocument ConsumerCreateToXml(bool <byHttps>, string <userName>, string <password>, ConsumerCreateParameters <consumerCreateParameters>, 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
ConsumerCreateParameters <consumerCreateParameters> A ConsumerCreateParameters 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

ConsumerCreateParameters

string <Description> The consumer description
string <CallSign> The consumer CallSign. This is Mandatory.
string <RadarDescription> The description that will appear in the radar for that consumer (if it is not present the consumer's radar will show the CallSign as description)
string <RadarDescriptionColor> The color of the description's text that will appear near the consumer's icon in the radar. This is expressed in RRGGBB format.
string <RadarDescriptionBGColor> The color of the description's background that will appear near the consumer's icon in the radar. This is expressed in RRGGBB format.
string <RadarDescriptionBorderColor> The color of the description's border that will appear near the consumer's icon in the radar. This is expressed in RRGGBB format.

Returned Type: XmlDocument

Returns an XML Document with the following structure:

<?xml version="1.0" encoding="utf-8" ?> 
<furesult>
	<message><![CDATA[ OK ]]></message>
	<creationid>44</creationid>
	<creationresult>0</creationresult>
</furesult>

 

Where

  • <message> contains OK or Error description
  • <creationid> if the command's result is OK this tag contains the just created new consumer's unique id
  • <creationresult> if the command's result is OK this tag contains:
    • 0 (zero) consumer created correctly
    • 1 (one) consumer not created.
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