CarpoolWorld REST API - Trip change

→ Developers → REST Api

Version:

1.0 2.0

REST API: Trip change

Changes a trip request.

Resource information

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

Request/Response Formats (IOFormat)

XML or JSON

HTTP Methods

POST

Resource description

Use POST https://www.carpoolworld.com/rest_trip.html/IOFormat

Resource URL

https://www.carpoolworld.com/rest_trip.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.
trip_id	required	Specify a valid trip number to change the data for the trip specified, use the trip_list specification to retrieve a list of trips and the details of each trip.
email	required	A valid email address for the traveler Up to 70 characters.
work_phone	optional	Telephone number where the traveler can be reached during the day. Up to 20 characters.
home_phone	optional	Telephone number where the traveler can be reached at night. Up to 20 characters.
home_street	optional	Origin street address Up to 70 characters.
home_city	required	Origin city Up to 70 characters.
home_state_prov	optional	Origin state or province code Up to 3 characters.
home_postal_zip	optional	Origin postal code or zip code Up to 15 characters.
home_country	required	Origin country code 6 characters. Refer to the list of valid country codes when specifying the country.
home_name	optional	Origin place description, can be a neighborhood, the name of a supermarket, park and ride lot, etc. Up to 70 characters.
olat	required	Latitude of the origin. The valid ranges for latitude is -90.0 to +90.0 (North is positive) inclusive. ex: 35.0226601 Decimal(12,7).
olon	required	Longitude of the origin. The valid ranges for longitude is -180.0 to +180.0 (East is positive) inclusive. ex:-106.4750121 Decimal(12,7).
work_street	optional	Destination street address Up to 70 characters.
work_city	required	Destination city Up to 70 characters.
work_state_prov	optional	Destination state or province code Up to 3 characters.
work_postal_zip	optional	Destination postal code or zip code Up to 15 characters.
work_country	required	Destination country code 6 characters. Refer to the list of valid country codes when specifying the country.
work_name	optional	Destination place description, can be the name of the employer, a subway station, park and ride lot, etc. Up to 70 characters.
dlat	required	Destination latitude. The valid ranges for latitude is -90.0 to +90.0 (North is positive) inclusive. ex: 52.0704978 Decimal(12,7).
dlon	required	Destination longitude. The valid ranges for longitude is -180.0 to +180.0 (East is positive) inclusive. ex: 4.3006999 Decimal(12,7).
leave_origin_time	optional	Desired time of arrival at destination. Time format example: 09:00:00 (12:00:00 is noon, 00:00:00 is midnight)
leave_destination_time	optional	Desired time to leave destination Time format example: 17:00:00 (12:00:00 is noon, 00:00:00 is midnight)
regular_schedule	required	Type of schedule N=One time trip, Y=Regular schedule, F=Flexible
day1	optional	Monday travel. 1=Yes, I wish to travel Monday.
day2	optional	Tuesday travel. 2=Yes, I wish to travel Tuesday.
day3	optional	Wednesday travel. 3=Yes, I wish to travel Wednesday.
day4	optional	Thursday travel. 4=Yes, I wish to travel Thursday.
day5	optional	Friday travel. 5=Yes, I wish to travel Friday.
day6	optional	Saturday travel. 6=Yes, I wish to travel Saturday.
day7	optional	Sunday travel. 7=Yes, I wish to travel Sunday.
days_vary	optional	Days specified can vary. Y=Days can vary N=Days do not vary
trip_date	required if one-time trip	Date of one-time trip, required if this is a one-time trip. For example 2013-01-23 is January 23, 2013 Date format YYYY-MM-DD
car	required	Driver or passenger D=Driver, P=Passenger, B=either Driver or Passenger
seats_offered	optional	Number of seats offered ex: 1
seats_required	optional	Number of seats required ex: 1
description	optional	Additional details about the trip if applicable. Text
smoker	optional	Smoker? Y=Smoker N=Non-Smoker
gender	optional	Gender? M=Male F=Female N=Nonbinary
sms_email	optional	SMS email Up to 70 characters. ex:8885551212@txt.vtext.com
match_outside	optional	Global matching Y=Match with everyone N=Match only with our group
status	optional	Trip status ""=active "X"=deleted "D"=passive
interested_in_modes	optional	Modes of transportations: 1 = carpooling 2 = vanpooling 3 = sharing a taxi 4 = walking 5 = bicycling 6 = telecommuting 7 = taking mass transportation ex: 145 represents: carpooling walking bicycling
cost_sharing	optional	Cost Sharing options: 1 = split costs 2 = take turns 3 = share coffee 4 = share music 5 = share food ex: 24 represents: take turns share music
cost_sharing_other	optional	Cost sharing other

JSON

{"trip":{
	"partner_name":"demo_group",
	"partner_key":"fdusiu32982pj2wj",
	"traveler_name":"happydriver",
	"traveler_password":"mysecretpassword123",
	"trip_id":"12345",
	"email":"iboulard@carpoolworld.com",
	"sms_email":"5551212514@txt.vtext.com",
	"work_phone":"333-22-22",
	"home_phone":{},"home_street":{},
	"home_city":"Winchester",
	"home_state_prov":"VA",
	"home_postal_zip":"22603",
	"home_country":"USA,US",
	"home_name":{},
	"olat":"39.314",
	"olon":"-78.2",
	"work_street":{},
	"work_city":"Southbury",
	"work_state_prov":"CT",
	"work_postal_zip":{},
	"work_country":"USA,US",
	"work_name":{},
	"dlat":"41.44",
	"dlon":"-73.2",
	"leave_origin_time":"09:00:00",
	"leave_destination_time":"17:00:00",
	"regular_schedule":"N",
	"day1":"1",
	"day2":"2",
	"day3":"3",
	"day4":"4",
	"day5":"5",
	"day6":{},
	"day7":{},
	"days_vary":"Y",
	"trip_date":"2013-01-23",
	"car":"P",
	"seats_required":"5",
	"seats_offered":"12",
	"description":"Just going from point a to point b",
	"smoker":"N",
	"gender":"F",
	"match_outside":"Y",
	"status":{}
	}
}

XML

<<<XML
<trips>
<trip>
<partner_name>demo_group</partner_name>
<partner_key>fdusiu32982pj2wj</partner_key>
<traveler_name>happydriver</traveler_name>
<traveler_password>mysecretpassword123</traveler_password>
<trip_id>12345</trip_id>
<email>happydriver@gmail.com</email>
<sms_email>8885551212@txt.vtext.com</sms_email>
<work_phone>333-22-22</work_phone>
<home_phone></home_phone>
<home_street></home_street>
<home_city>Winchester</home_city>
<home_state_prov>VA</home_state_prov>
<home_postal_zip>22603</home_postal_zip>
<home_country>USA,US</home_country>
<home_name></home_name>
<olat>39.314</olat>
<olon>-78.2</olon>
<work_street></work_street>
<work_city>Southbury</work_city>
<work_state_prov>CT</work_state_prov>
<work_postal_zip></work_postal_zip>
<work_country>USA,US</work_country>
<work_name></work_name>
<dlat>41.44</dlat>
<dlon>-73.2</dlon>
<leave_origin_time>09:00:00</leave_origin_time>
<leave_destination_time>17:00:00</leave_destination_time>
<regular_schedule>N</regular_schedule>
<day1>1</day1>
<day2>2</day2>
<day3>3</day3>
<day4>4</day4>
<day5>5</day5>
<day6></day6>
<day7></day7>
<days_vary>Y</days_vary>
<trip_date>20101223</trip_date>
<car>P</car>
<description>Just going from point a to point b, looking to split the costs</description>
<smoker>N</smoker>
<gender>F</gender>
<match_outside>Y</match_outside>
<status></status>
</trip>
</trips>
XML;

Responses

The response is formatted as follows

JSON
XML

JSON

{"status_detail":[
     {
      "status_code":"0000",
      "status_traveler":"happydriver",
      "status_trip":"0",
      "status_message":"Initialize"
      },  
      {
      	"status_code":"1000",
      	"status_traveler":"happydriver",
      	"status_trip":"383342",
      	"status_message":"SUCCESS - trip added 383342"
      },
      {"status_code":"1001",
      "status_traveler":"happydriver",
      "status_trip":"383342",
      "status_message":"List trips for traveler happydriver 383342"
      },
      {
      	"status_code":"1002",
      	"status_traveler":"happydriver",
      	"status_trip":"383342",
      	"status_message":{
      		"trips":{
      			"trip":{
      				"traveler":"happydriver",
      				"trip_id":"383342",
      				"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 15:08:54",
      				"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":"ec6cNAR5D6",
      				"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":{},
      				"gender":"F",
      				"smoke":"N",
      				"cost_sharing":{},
      				"cost_sharing_other":{},
      				"seats_offered":"12",
      				"seats_required":"5",
      				"feature":{},
      				"join_grh":{},
      				"agree_grh":{},
      				"join_emergency":{},
      				"match_emergency":{}
      				}
      			}
      		}
      	},
      	{
      		"status_code":"9999",
      		"status_traveler":"happydriver",
      		"status_trip":"383342",
      		"status_message":"Finalize"
      	}
   ]
}

XML

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

List of valid country codes

AFG,AF	Afghanistan
ALB,AL	Albania
DZA,DZ	Algeria
ASM,AS	American Samoa
AND,AD	Andorra
AGO,AO	Angola
AIA,AI	Anguilla
ATA,AQ	Antarctica
ATG,AG	Antigua And Barbuda
ARG,AR	Argentina
ARM,AM	Armenia
ABW,AW	Aruba
AUS,AU	Australia
AUT,AT	Austria
AZE,AJ	Azerbaijan
BHS,BS	Bahamas
BHR,BH	Bahrain
BGD,BD	Bangladesh
BRB,BB	Barbados
BLR,BY	Belarus
BEL,BE	Belgium
BLZ,BZ	Belize
BEN,BJ	Benin
BMU,BM	Bermuda
BTN,BT	Bhutan
BOL,BO	Bolivia
BIH,BA	Bosnia And Herzegowina
BWA,BW	Botswana
BVT,BV	Bouvet Island
BRA,BR	Brazil
IOT,IO	British Indian Ocean Territory
BRN,BN	Brunei Darussalam
BGR,BG	Bulgaria
BFA,BF	Burkina Faso
BDI,BI	Burundi
KHM,KH	Cambodia
CMR,CM	Cameroon
CAN,CA	Canada
CPV,CV	Cape Verde
CYM,KY	Cayman Islands
CAF,CF	Central African Republic
TCD,TD	Chad
CHL,CL	Chile
CHN,CN	China
CXR,CX	Christmas Island
CCK,CC	Cocos Islands Keeling
COL,CO	Colombia
COM,KM	Comoros
COG,CG	Congo
COD,ZR	Congo The Democratic Republic Of The
COK,CK	Cook Islands
CRI,CR	Costa Rica
HRV,HR	Croatia Hrvatska
CUB,CU	Cuba
CYP,CY	Cyprus
CZE,CZ	Czech Republic
DNK,DK	Denmark
DJI,DJ	Djibouti
DMA,DM	Dominica
DOM,DO	Dominican Republic
TMP,TP	East Timor
ECU,EC	Ecuador
EGY,EG	Egypt
SLV,SV	El Salvador
GNQ,GQ	Equatorial Guinea
ERI,ER	Eritrea
EST,EE	Estonia
ETH,ET	Ethiopia
FLK,FK	Falkland Islands Malvinas
FRO,FO	Faroe Islands
FJI,FJ	Fiji
FIN,FI	Finland
FRA,FR	France
GUF,GF	French Guiana
PYF,PF	French Polynesia
ATF,TF	French Southern Territories
GAB,GA	Gabon
GMB,GM	Gambia
GEO,GE	Georgia
DEU,DE	Germany
GHA,GH	Ghana
GIB,GI	Gibraltar
GRC,GR	Greece
GRL,GL	Greenland
GRD,GD	Grenada
GLP,GP	Guadeloupe
GUM,GU	Guam
GTM,GT	Guatemala
GIN,GN	Guinea
GNB,GW	Guinea-bissau
GUY,GY	Guyana
HTI,HT	Haiti
HMD,HM	Heard And Mc Donald Islands
VAT,VA	Holy See Vatican City State
HND,HN	Honduras
HKG,HK	Hong Kong
HUN,HU	Hungary
ISL,IS	Iceland
IND,IN	India
IDN,ID	Indonesia
IRN,IR	Iran
IRQ,IQ	Iraq
IRL,IE	Ireland
ISR,IL	Israel
ITA,IT	Italy
CIV,CI	Ivory Coast Republic Of The
JAM,JM	Jamaica
JPN,JP	Japan
JOR,JO	Jordan
KAZ,KZ	Kazakhstan
KEN,KE	Kenya
KIR,KI	Kiribati
KWT,KW	Kuwait
KGZ,KG	Kyrgyzstan
LAO,LA	Laos
LVA,LV	Latvia
LBN,LB	Lebanon
LSO,LS	Lesotho
LBR,LR	Liberia
LBY,LY	Libya
LIE,LI	Liechtenstein
LTU,LT	Lithuania
LUX,LU	Luxembourg
MAC,MO	Macau
MKD,MK	Macedonia
MDG,MG	Madagascar
MWI,MW	Malawi
MYS,MY	Malaysia
MDV,MV	Maldives
MLI,ML	Mali
MLT,MT	Malta
MHL,MH	Marshall Islands
MTQ,MQ	Martinique
MRT,MR	Mauritania
MUS,MU	Mauritius
MYT,YT	Mayotte
MEX,MX	Mexico
FSM,FM	Micronesia Federated States Of
MDA,MD	Moldova
MCO,MC	Monaco
MNG,MN	Mongolia
MNE,ME	Montenegro
MSR,MS	Montserrat
MAR,MA	Morocco
MOZ,MZ	Mozambique
MMR,MM	Myanmar
NAM,NA	Namibia
NRU,NR	Nauru
NPL,NP	Nepal
NLD,NL	Netherlands
ANT,AN	Netherlands Antilles
NCL,NC	New Caledonia
NZL,NZ	New Zealand
NIC,NI	Nicaragua
NER,NE	Niger
NGA,NG	Nigeria
NIU,NU	Niue
NFK,NF	Norfolk Island
MNP,MP	Northern Mariana Islands
NOR,NO	Norway
OMN,OM	Oman
PAK,PK	Pakistan
PLW,PW	Palau
PSE,PS	Palestinian Territory
PAN,PA	Panama
PNG,PG	Papua New Guinea
PRY,PY	Paraguay
PER,PE	Peru
PHL,PH	Philippines
PCN,PN	Pitcairn
POL,PL	Poland
PRT,PT	Portugal
PRI,PR	Puerto Rico
QAT,QA	Qatar
REU,RE	Reunion
ROM,RO	Romania
RUS,RU	Russian Federation
RWA,RW	Rwanda
KNA,KN	Saint Kitts And Nevis
LCA,LC	Saint Lucia
VCT,VC	Saint Vincent And The Grenadines
WSM,WS	Samoa
SMR,SM	San Marino
STP,ST	Sao Tome And Principe
SAU,SA	Saudi Arabia
SEN,SN	Senegal
SRB,RS	Serbia
SYC,SC	Seychelles
SLE,SL	Sierra Leone
SGP,SG	Singapore
SVK,SK	Slovakia
SVN,SI	Slovenia
SLB,SB	Solomon Islands
SOM,SO	Somalia
ZAF,ZA	South Africa
SGS,GS	South Georgia And The South Sandwich Islands
KOR,KR	South Korea
ESP,ES	Spain
LKA,LK	Sri Lanka
SHN,SH	St. Helena
SPM,PM	St. Pierre And Miquelon
SDN,SD	Sudan
SUR,SR	Suriname
SJM,SJ	Svalbard And Jan Mayen Islands
SWZ,SZ	Swaziland
SWE,SE	Sweden
CHE,CH	Switzerland
SYR,SY	Syria
TWN,TW	Taiwan
TJK,TJ	Tajikistan
TZA,TZ	Tanzania
THA,TH	Thailand
TGO,TG	Togo
TKL,TK	Tokelau
TON,TO	Tonga
TTO,TT	Trinidad And Tobago
TUN,TN	Tunisia
TUR,TR	Turkey
TKM,TM	Turkmenistan
TCA,TC	Turks And Caicos Islands
TUV,TV	Tuvalu
UGA,UG	Uganda
UKR,UA	Ukraine
ARE,AE	United Arab Emirates
GBR,UK	United Kingdom
USA,US	United States
UMI,UM	United States Minor Outlying Islands
URY,UY	Uruguay
UZB,UZ	Uzbekistan
VUT,VU	Vanuatu
VEN,UE	Venezuela
VNM,VN	Vietnam
VGB,VG	Virgin Islands British
VIR,VI	Virgin Islands Us
WLF,WF	Wallis And Futuna Islands
ESH,EH	Western Sahara
YEM,YE	Yemen
ZMB,ZM	Zambia
ZWE,ZW	Zimbabwe