CarpoolWorld REST API - Trip list

→ Developers → REST Api

Version:

1.0 2.0

REST API: Trip list

Retrieve a list of trips for a specific traveler.

Resource information

https://www.carpoolworld.com/rest_trip_list.html

Request/Response Formats (IOFormat)

XML or JSON

HTTP Methods

POST or GET

Resource description

Use POST or GET https://www.carpoolworld.com/rest_trip_list.html/IOFormat

Resource URL

https://www.carpoolworld.com/rest_trip_list.html/IOFormat

Parameters

partner_name	required	Your developer partner name
partner_key	required	Your developer partner key
traveler_name	required	A traveler name of your choice. Up to 20 characters. Letters (a-z), numbers (0-9) and underscores (_) are allowed
traveler_password	required	A traveler password of your choice, if this is an existing traveler, the passwords must match. The password are stored encrypted in the carpoolworld database Up to 20 characters.

JSON

XML

Responses

The response is formatted as follows

JSON
XML

JSON

{"status_detail":[
			  		    {
			  		    	"status_code":"0000",
			  		    	"status_traveler":"happydriver",
			  		    	"status_trip":{},
			  		    	"status_message":"Initialize"
			  		    }, 
			  		    {
			  		    	"status_code":"1001",
			  		    	"status_traveler":"happydriver",
			  		    	"status_trip":{},
			  		    	"status_message":"List trips for traveler happydriver 383340"
			  		    },
			  		    {
			  		    	"status_code":"1002",
			  		    	"status_traveler":"happydriver",
			  		    	"status_trip":{},
			  		    	"status_message":{
			  		    		"trips":{
			  		    			"trip":[
			  		    			{
			  		    				"traveler":"happydriver",
			  		    				"trip_id":"383340",
			  		    				"traveler_name":{},
			  		    				"olat":"39.3140000",
			  		    				"olon":"-78.2000000",
			  		    				"dlat":"41.4400000",
			  		    				"dlon":"-73.2000000",
			  		    				"leave_origin_time":"09:00:00",
			  		    				"leave_destination_time":"17:00:00",
			  		    				"description":"Just going from point a to point b",
			  		    				"expiration_date":"0000-00-00",
			  		    				"recorded":"2015-12-13 12:29:59",
			  		    				"status":{},
			  		    				"email_verified":"N",
			  		    				"home_street":{},
			  		    				"home_city":"Winchester",
			  		    				"home_state_prov":"VA",
			  		    				"home_postal_zip":"22603",
			  		    				"work_street":{},
			  		    				"work_city":"Southbury",
			  		    				"work_state_prov":"CT",
			  		    				"work_postal_zip":{},
			  		    				"home_country":"USA,US",
			  		    				"work_country":"USA,US",
			  		    				"sent_email":{},
			  		    				"home_phone":{},
			  		    				"work_phone":"333-22-22",
			  		    				"match_outside":"Y",
			  		    				"home_encoded_by":{},
			  		    				"work_encoded_by":{},
			  		    				"date_created":"2015-12-13",
			  		    				"car":"P",
			  		    				"home_name":{},
			  		    				"work_name":{},
			  		    				"trip_date":"2013-01-23",
			  		    				"day1":"1",
			  		    				"day2":"2",
			  		    				"day3":"3",
			  		    				"day4":"4",
			  		    				"day5":"5",
			  		    				"day6":"6",
			  		    				"day7":"7",
			  		    				"regular_schedule":"N",
			  		    				"days_vary":"Y",
			  		    				"sms_email":"5551212514@txt.vtext.com",
			  		    				"agree":"Y",
			  		    				"random_field_identifier":"fMe3dM2frs",
			  		    				"map_distance":"585554",
			  		    				"map_duration":"20759",
			  		    				"match_schedule_date_constraint":"2",
			  		    				"match_day1":"0",
			  		    				"match_day2":"0",
			  		    				"match_day3":"3",
			  		    				"match_day4":"0",
			  		    				"match_day5":"0",
			  		    				"match_day6":"0",
			  		    				"match_day7":"0",
			  		    				"interested_in_modes":"#carpool #taxishare",
			  		    				"gender":"F",
			  		    				"smoke":"N",
			  		    				"cost_sharing":"#splitcosts #sharecoffee #sharefood",
			  		    				"cost_sharing_other":"having fun!",
			  		    				"seats_offered":"12",
			  		    				"seats_required":"5",
			  		    				"feature":{},
			  		    				"join_grh":{},
			  		    				"agree_grh":{},
			  		    				"join_emergency":{},
			  		    				"match_emergency":{},
			  		    				"url_image":"https://www.carpoolworld.com/images/bonhomme_small_2_v3.png"	
			  		    			},
			  		    			{
			  		    				"traveler":"happydriver",
			  		    				"trip_id":"383339",
			  		    				"traveler_name":{},
			  		    				"olat":"39.3140000",
			  		    				"olon":"-78.2000000",
			  		    				"dlat":"41.4400000",
			  		    				"dlon":"-73.2000000",
			  		    				"leave_origin_time":"09:00:00",
			  		    				"leave_destination_time":"17:00:00",
			  		    				"description":"Just going from point a to point b",
			  		    				"expiration_date":"0000-00-00",
			  		    				"recorded":"2015-12-13 12:27:18",
			  		    				"status":{},
			  		    				"email_verified":"N",
			  		    				"home_street":{},
			  		    				"home_city":"Winchester",
			  		    				"home_state_prov":"VA",
			  		    				"home_postal_zip":"22603",
			  		    				"work_street":{},
			  		    				"work_city":"Southbury",
			  		    				"work_state_prov":"CT",
			  		    				"work_postal_zip":{},
			  		    				"home_country":"USA,US",
			  		    				"work_country":"USA,US",
			  		    				"sent_email":{},
			  		    				"home_phone":{},
			  		    				"work_phone":"333-22-22",
			  		    				"match_outside":"Y",
			  		    				"home_encoded_by":{},
			  		    				"work_encoded_by":{},
			  		    				"date_created":"2015-12-13",
			  		    				"car":"P",
			  		    				"home_name":{},
			  		    				"work_name":{},
			  		    				"trip_date":"2013-01-23",
			  		    				"day1":"1",
			  		    				"day2":"2",
			  		    				"day3":"3",
			  		    				"day4":"4",
			  		    				"day5":"5",
			  		    				"day6":"6",
			  		    				"day7":"7",
			  		    				"regular_schedule":"N",
			  		    				"days_vary":"Y",
			  		    				"sms_email":"5551212514@txt.vtext.com",
			  		    				"agree":"Y",
			  		    				"random_field_identifier":"y912hI5psS",
			  		    				"map_distance":"585554",
			  		    				"map_duration":"20759",
			  		    				"match_schedule_date_constraint":"2",
			  		    				"match_day1":"0",
			  		    				"match_day2":"0",
			  		    				"match_day3":"3",
			  		    				"match_day4":"0",
			  		    				"match_day5":"0",
			  		    				"match_day6":"0",
			  		    				"match_day7":"0",
			  		    				"interested_in_modes":"#carpool #taxishare",
			  		    				"gender":"F",
			  		    				"smoke":"N",
			  		    				"cost_sharing":"#splitcosts #sharecoffee #sharefood",
			  		    				"cost_sharing_other":"having fun!",
			  		    				"seats_offered":"12",
			  		    				"seats_required":"5",
			  		    				"feature":{},
			  		    				"join_grh":{},
			  		    				"agree_grh":{},
			  		    				"join_emergency":{},
			  		    				"match_emergency":{},
			  		    				"url_image":"https://www.carpoolworld.com/images/bonhomme_small_2_v3.png"
			  		    			}]
			  		    		}
			  		    	}
			  		    },
			  		    {
			  		    	"status_code":"9999",
			  		    	"status_traveler":"happydriver",
			  		    	"status_trip":{},
			  		    	"status_message":"Finalize"
			  		    }]}

XML

<status_detail>
							<status_code>1002</status_code>
							<status_traveler>happydriver</status_traveler>
							<status_trip></status_trip>
							<status_message>
							<trips>
							<trip>
							<traveler>happydriver</traveler>
							<trip_id>212718</trip_id>
							<traveler_name>happydriver</traveler_name>
							<olat>39.3140000</olat>
							<olon>-78.2000000</olon>
							<dlat>41.4400000</dlat>
							<dlon>-73.2000000</dlon>
							<leave_origin_time>09:00:00</leave_origin_time>
							<leave_destination_time>17:00:00</leave_destination_time>
							<description>Just going from point a to point b</description>
							<expiration_date>0000-00-00</expiration_date>
							<recorded>2012-11-05 15:50:15</recorded>
							<status></status>
							<email_verified>Y</email_verified>
							<home_street></home_street>
							<home_city>Winchester</home_city>
							<home_state_prov>VA</home_state_prov>
							<home_postal_zip>22603</home_postal_zip>
							<work_street></work_street>
							<work_city>Southbury</work_city>
							<work_state_prov>CT</work_state_prov>
							<work_postal_zip></work_postal_zip>
							<home_country>USA,US</home_country>
							<work_country>USA,US</work_country>
							<sent_email></sent_email>
							<home_phone></home_phone>
							<work_phone>333-22-22</work_phone>
							<match_outside>Y</match_outside>
							<home_encoded_by></home_encoded_by>
							<work_encoded_by></work_encoded_by>
							<date_created>2012-11-05</date_created>
							<car>P</car>
							<home_name></home_name>
							<work_name></work_name>
							<trip_date>2013-01-23</trip_date>
							<day1>1</day1>
							<day2>2</day2>
							<day3>3</day3>
							<day4>4</day4>
							<day5>5</day5>
							<day6>6</day6>
							<day7>7</day7>
							<regular_schedule>N</regular_schedule>
							<days_vary>Y</days_vary>
							<sms_email>5551212514@txt.vtext.com</sms_email>
							<average_rating>5</average_rating>
							<agree>Y</agree>
							<random_field_identifier>lMdJDD8ceR</random_field_identifier>
							<map_distance>588267</map_distance>
							<map_duration>24138</map_duration>
							<match_schedule_date_constraint>2</match_schedule_date_constraint>
							<match_day1>0</match_day1>
							<match_day2>0</match_day2>
							<match_day3>3</match_day3>
							<match_day4>0</match_day4>
							<match_day5>0</match_day5>
							<match_day6>0</match_day6>
							<match_day7>0</match_day7>
							<interested_in_modes>#carpool #taxishare</interested_in_modes>
							<gender>F</gender>
							<smoke>N</smoke>
							<cost_sharing>#splitcosts #sharecoffee #sharefood</cost_sharing>		
							<cost_sharing_other>have fun!</cost_sharing_other>	
							<seats_offered>12</seats_offered>
							<seats_required>5</seats_required>
							<feature></feature>
							<url_image>https://www.carpoolworld.com/images/bonhomme_small_2_v3.png</url_image>	
							</trip>
							</trips>
							</status_message>
							</status_detail>

Success or error	Status	Description
	9000	Invalid partner or partner key
	9001	Invalid traveler login
	9002	ERRORlistsallerrors
	0000	Initialize
	1002	trip details for traveler traveler_name
	9999	Finalize