CarpoolWorld REST API - Trip contact
→ Developers
→ REST Api
REST API: Trip contact
Contact a traveler to make carpooling arrangements.
Resource information
https://www.carpoolworld.com/rest_email.html/trip_id#
Request/Response Formats (IOFormat)
XML or JSON
HTTP Methods
POST
Resource description
Use POST https://www.carpoolworld.com/rest_email.html/trip_id#/IOFormatResource URL
https://www.carpoolworld.com/rest_email.html/trip_id#/IOFormatParameters
| 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. |
| to_traveler_name | required | The traveler name to contact. Up to 20 characters. Letters (a-z), numbers (0-9) and underscores (_) are allowed |
| to_trip_id | required | Specify the trip number of the traveler to be contacted, see the trip_match specification to retrieve a list of matches (traveler, trip id) for a traveler/trip combination. |
| subject | optional | Subject of the email |
| message | optional | Message of the email |
| message_preset | optional | Preset message type (leave the message and subject empty with the presets so that CarpoolWorld generates the message)
a=Accept d=Decline v=Remind n=Cancel request |
| message_initial_sequence | optional | If using message_preset, send the sequence of the initial message sequence for the type '2' retrieved with trip_match_conversation for that conversation. |