{"_id":"557f76ac38249b0d00d0d15b","__v":1,"category":{"_id":"557f736366ed730d00c8a38c","project":"557f5c2aeb75d80d00af40db","__v":9,"pages":["557f74ff66ed730d00c8a397","557f76ac38249b0d00d0d15b","557f7f0966ed730d00c8a3a0","557f7f3a38249b0d00d0d176","557f7f7566ed730d00c8a3a2","557f7f83e4f3070d0068aa24","557f7f8ee4f3070d0068aa25","557f7f9c38249b0d00d0d179","55bab9c61b0d663700781621"],"version":"557f736266ed730d00c8a388","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-06-16T00:11:28.806Z","from_sync":false,"order":3,"slug":"event-api","title":"Event API"},"editedParams":true,"version":{"_id":"557f736266ed730d00c8a388","project":"557f5c2aeb75d80d00af40db","__v":1,"forked_from":"557f5c2aeb75d80d00af40de","createdAt":"2015-06-16T00:52:50.718Z","releaseDate":"2015-06-16T00:52:50.718Z","categories":["557f736366ed730d00c8a389","557f736366ed730d00c8a38a","557f736366ed730d00c8a38b","557f736366ed730d00c8a38c"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"2.0.19","version":"2.0.19"},"editedParams2":true,"githubsync":"","project":"557f5c2aeb75d80d00af40db","user":"557f5be9eb75d80d00af40d9","parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-06-16T01:06:52.167Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"settings":"557f75ba38249b0d00d0d152","examples":{"codes":[{"language":"curl","code":" curl 'https://api.clearpathgps.com:8443/events/Data.xml?user=me:::at:::myco.com&password=secret&group=all&limit=5'","name":""}]},"method":"get","results":{"codes":[{"name":"","code":"<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<Account account=\"clearpathgps\" timezone=\"US/Pacific\">\n <Description><![CDATA[ClearPathGPS]]></Description>\n <Device id=\"4542088719\">\n  <Description><![CDATA[Steve]]></Description>\n  <DisplayName><![CDATA[Steve]]></DisplayName>\n  <EventData device=\"4542088719\">\n   <Timestamp epoch=\"1434415923\">2015/06/15 17:52:03 PDT</Timestamp>\n   <StatusCode code=\"0xF020\"><![CDATA[Moving]]></StatusCode>\n   <StatusCodeColor color=\"#53C153\"><![CDATA[#53C153]]></StatusCodeColor>\n   <GPSPoint>34.4499263,-119.6956753</GPSPoint>\n   <Speed units=\"mph\">28.6</Speed>\n   <Heading degrees=\"297.0\"><![CDATA[NW]]></Heading>\n   <Odometer units=\"Miles\">2954.2</Odometer>\n   <Address><![CDATA[1564 Las Canoas Road, Santa Barbara, CA 93105, USA]]></Address>\n  </EventData>\n  <EventData device=\"4542088719\">\n   <Timestamp epoch=\"1434415954\">2015/06/15 17:52:34 PDT</Timestamp>\n   <StatusCode code=\"0xF020\"><![CDATA[Moving]]></StatusCode>\n   <StatusCodeColor color=\"#53C153\"><![CDATA[#53C153]]></StatusCodeColor>\n   <GPSPoint>34.4519883,-119.6995548</GPSPoint>\n   <Speed units=\"mph\">17.4</Speed>\n   <Heading degrees=\"292.0\"><![CDATA[W]]></Heading>\n   <Odometer units=\"Miles\">2954.5</Odometer>\n   <Address><![CDATA[1645 Las Canoas Road, Santa Barbara, CA 93105, USA]]></Address>\n  </EventData>\n </Device>\n <Device id=\"4731009570\">\n  <Description><![CDATA[Scott]]></Description>\n  <DisplayName><![CDATA[Scott]]></DisplayName>\n  <EventData device=\"4731009570\">\n   <Timestamp epoch=\"1434413815\">2015/06/15 17:16:55 PDT</Timestamp>\n   <StatusCode code=\"0xF020\"><![CDATA[Moving]]></StatusCode>\n   <StatusCodeColor color=\"#53C153\"><![CDATA[#53C153]]></StatusCodeColor>\n   <GPSPoint>34.4281925,-119.6924521</GPSPoint>\n   <Speed units=\"mph\">6.8</Speed>\n   <Heading degrees=\"276.0\"><![CDATA[W]]></Heading>\n   <Odometer units=\"Miles\">65385.5</Odometer>\n   <Address><![CDATA[701-799 East Canon Perdido Street, Santa Barbara, CA 93103, USA]]></Address>\n  </EventData>\n  <EventData device=\"4731009570\">\n   <Timestamp epoch=\"1434413835\">2015/06/15 17:17:15 PDT</Timestamp>\n   <StatusCode code=\"0xF403\"><![CDATA[Ignition_Off]]></StatusCode>\n   <StatusCodeColor color=\"#FE2121\"><![CDATA[#FE2121]]></StatusCodeColor>\n   <StopTime stoptime=\"1h 05m\"><![CDATA[1h 05m]]></StopTime>\n   <GPSPoint>34.4281380,-119.6925163</GPSPoint>\n   <Speed units=\"mph\">0.0</Speed>\n   <Odometer units=\"Miles\">65385.5</Odometer>\n   <Address><![CDATA[701-799 East Canon Perdido Street, Santa Barbara, CA 93103, USA]]></Address>\n  </EventData>\n </Device>\n</Account>","language":"xml","status":200}]},"auth":"required","params":[{"_id":"557f76ac38249b0d00d0d15c","ref":"","in":"query","required":false,"desc":"The user name","default":"","type":"string","name":"user"},{"_id":"557f79f238249b0d00d0d164","ref":"","in":"query","required":false,"desc":"The password","default":"","type":"string","name":"password"},{"_id":"557f79f238249b0d00d0d163","ref":"","in":"query","required":false,"desc":"The device ID (Optional)","default":"","type":"string","name":"device"},{"_id":"557f79f238249b0d00d0d162","ref":"","in":"query","required":false,"desc":"The group ID (Optional)","default":"","type":"string","name":"group"},{"_id":"557f79f238249b0d00d0d161","ref":"","in":"query","required":false,"desc":"Time From - UTC in epoch format (Optional)","default":"","type":"timestamp","name":"rf"},{"_id":"557f79f238249b0d00d0d160","ref":"","in":"query","required":false,"desc":"Time To - UTC in epoch format (Optional)","default":"","type":"timestamp","name":"rt"},{"_id":"557f79f238249b0d00d0d15f","ref":"","in":"query","required":false,"desc":"Limit number of returned events (Optional)","default":"","type":"int","name":"limit"},{"_id":"557f79f238249b0d00d0d15e","ref":"","in":"query","required":false,"desc":"Display Additional Fields (Optional)","default":"","type":"boolean","name":"allTags"}],"url":"/Data.xml"},"isReference":false,"order":1,"body":"","excerpt":"","slug":"retrieve-events-xml-format","type":"endpoint","title":"Retrieve Events - XML Format"}

getRetrieve Events - XML Format


Definition

{{ api_url }}{{ page_api_url }}

Parameters

Query Params

user:
string
The user name
password:
string
The password
device:
string
The device ID (Optional)
group:
string
The group ID (Optional)
rf:
timestamp
Time From - UTC in epoch format (Optional)
rt:
timestamp
Time To - UTC in epoch format (Optional)
limit:
integer
Limit number of returned events (Optional)
allTags:
boolean
Display Additional Fields (Optional)

Examples


Result Format