GetTrackListToXml

Returns the list of user's tracks in XML format

public XmlDocument GetTrackListToXml(bool <byHttps>, string <userName>, string <password>, TrackListParameters <trackListParameters>, 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
TrackListParameters <trackListParameters> A TrackListParameters 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

TrackListParameters

Uint32? <Consumer> Consumer Id by which search the tracks
DateTime? <DateTimeFrom> Set the starting date for searching tracks
DateTime? <DateTimeTo> Set the ending date for searching tracks
UInt32? <Friend> If set return a list of friend's tracks
UInt32? <MaxItem> Used for paging results. If set returns tracks less than this value.
Note that order to prevent your system from being flooded with oversized responses, the number of messages that will be returned on a single response is limited to 500.
UInt32? <MinItem> Used for paging results. If set returns tracks greater than this value.
UpdatePositionValue <UpdatePosition> If set returns tracks that have <updateposition> = 0 (NoUpdateRadar), <updateposition> = 1 (UpdateRadar), <updateposition> = 2 (All). Default is All.

Returned Type: XmlDocument

Returns an XML Document with the following structure:

<?xml version="1.0" encoding="utf-8" ?> 
<furesult>
	<message><![CDATA[ OK ]]></message>
	<items>
		<item>
			<id>10</id>
			<description><![CDATA[Molinella / Ozzano]]></description>
			<autoclosed>null</autoclosed>
			<starttime>20101110110816</starttime>
		</item> 
		<item>
			<id>12</id>
			<description><![CDATA[Molinella / Ferrara]]></description>
			<autoclosed>0</autoclosed>
			<starttime>20101110093010</starttime>
			<endtime>20101110104520</endtime>
		</item>
	</items>
</furesult>

 

Where

  • <message> contains OK or Error description
  • <items> if the command succeeded and <message> contains “OK” this tag is present and contain the list of tracks with the following tags:
    • <item> each element of the list. This can be repeated many times
      • <id> the Id of the track: it's the only way to identify the track.
      • <description> a string containing the track's description given by the user
      • <autoclosed> This value can be:
        • null – the track is open
        • 0 (zero) – the track was closed correctly
        • 1 (one) – the track was closed by the server
      • <starttime> UCT date and time when the Track has been created in yyyyMMddhhmmss format
      • <endtime> UCT date and time when the Track has been closed in yyyyMMddhhmmss format (this value exists only if the track is closed)
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