CarPool2Camp.org™

CarPool2Camp.org Web Services API Documentation V2

Purpose

The CarPool2Camp.org Web Services API allows you to embed the PoolPass® and Ride Match functionality into your own camp web site. Your campers' experience can be seamless, with your programming handling the client interface, and CarPool2Camp.org handling all of the data base, geolocation and ride-match technologies. A series of API actions are available to implement the standard CRUD functions. These are supplemented by three additional functions that enable you to Match riders, retrieve All PoolPass® records for your camp, and get a New empty PoolPass®.

You should be familiar with server-side programming to use the API.

Request URL

http://www.carpool2camp.org/v2api/

Request Parameters

To learn more about RESTful queries, please visit http://developer.yahoo.com/search/rest.html.

Param Value Description
key string
(required)
The application programming interface key. See "API Keys" for more information.
act string
(required)
The action code, telling the API what data to expect and what data to return. These action codes are as follows:
  • C - Create a new PoolPass® record and return the contents
  • R - Retrieve the contents of a PoolPass® record
  • U - Update the contents of a PoolPass® record
  • D - Destroy a PoolPass® record
  • M - Return the ride matches for a given PoolPass® record
  • A - Spew the contents of all PoolPass® records
  • N - Create a new, empty Electronic PoolPass® record
P string
(required)
The PoolPass® string, a unique nine-character field created by the CarPool2Camp.org data base.
This value is ignored when the action code is "C" or "A"
This value is required for other calls to the API.
N string
(optional)
The name of the camper.
A string
(optional)
The street address of the camper.
C string
(optional)
The city address of the camper.
S string
(optional)
The state address of the camper - two character abbreviation.
Z string
(optional)
The ZIP code address of the camper.
H string
(optional)
The country code (homeland) of the camper.
D string
(optional)
The date of travel to camp. ISO8601 format like YYYY-MM-DD.
E string
(required)
The email address of the camper. This field must be included in the CREATE request.
F string
(optional)
The telephone number of the camper.
O string
(optional)
Notes. This field is intended to provide a place for the camper to share a simple message with his fellow campers, such as "Let's leave early and eat at IHOP" or "I have room for four passengers."
W string
(optional)
Camp data. This field is intended to provide a place for the camp to store its own data in the API data base.
T string
(optional)
(required)
Acceptance of the terms of use.
This field must specify "T=Y" to indicate acceptance of the Terms of Use.
Required for CREATE or UPDATE.

Sample Request URLs

A request to create a new PoolPass® record
    [URL]?key=[APIkey]&act=C&T=Y&e=camper@campers.org&n=John+Q.+Camper

A request to update the phone number for an existing PoolPass® record
    [URL]?key=[APIkey]&act=U&T=Y&p=[PoolPass®key]&f=(703)+555-1212

A request to find all of the ride-match candidates for a PoolPass®
    [URL]?key=[APIkey]&p=[PoolPass®key]&act=M

Response Fields

The schema document for this service response is here: http://www.carpool2camp.org/v2api/ApiResponse.xsd

Field Description
ResultSet Contains all of the query responses.
Result Contains each individual response.
More than one result may be returned in response to act=A or act=M.
An abbreviated result may be returned in response to act=D.
An abbreviated result will always be returned in case of an error condition - any time that the response attribute code is not 200.

Has attributes:
    timestamp - ISO8601 timestamp of the request
    warning - a textual explanation of the code (optional)
    code - similar to HTTP response codes
        200 OK
        204 NO DATA FOUND
        400 BAD REQUEST
        403 REQUEST DENIED
        404 RECORD NOT FOUND
        503 SERVICE UNAVAILABLE
Poolpass The 9-character PoolPass® of this record
Name Camper's name
Address Camper's street address
City Camper's city
State Camper's state - two character abbreviation
Zip Camper's zip code, may contain ZIP or ZIP+4 like 22101-3104
Country Camper's Country
Phone Camper's telephone number
Email Camper's email address
Date Camper's travel date
Note Camper's free-form note field
Campdata Camp's free-form data field
Distance The distance in miles of this camper from the camper holding the PoolPass® that was presented in a request containing act=M

Sample Response to act=R&p=Y5REDJ6KW

<?xml version="1.0"?>
<ResultSet xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns="urn:yahoo:maps"
    xsi:schemaLocation="urn:yahoo:maps http://carpool2camp.org/v2api/ApiResponse.xsd">
      <Result code="200" timestamp="2008-12-04T19:50:56-0600">
          <Poolpass>Y5REDJ6KW</Poolpass>
          <Name>Ray Paseur</Name>
          <Address>6327 Everglades Dr</Address>
          <City>Alexandria</City>
          <State>VA</State>
          <Zip>22312-1113</Zip>
          <Country></Country>
          <Phone>703.555.1212</Phone>
          <Email>Ray.Paseur@AOL.com</Email>
          <Date>2008-12-25</Date>
          <Note>Let's leave early and go to IHOP</Note>
          <Campdata></Campdata>
      </Result>
</ResultSet>

Sample Response to act=R&p=[unknown]

<?xml version="1.0"?>
<ResultSet xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns="urn:yahoo:maps"
    xsi:schemaLocation="urn:yahoo:maps http://carpool2camp.org/v2api/ApiResponse.xsd">
      <Result code="404" timestamp="2008-12-04T19:50:56-0600"
              warning="POOLPASS [unknown] NOT FOUND">
      </Result>
</ResultSet>

Errors

The service does not return errors. Check the Result["code"] field and the Result["warning"] field.

Rate Limit

The service is not rate limited.

API Keys

The API Web Services are offered for a subscription fee, and an API key is required to use the services. One API key is required for each camp destination. The API key is a unique 40 character string.

Terms of Use

Use is subject to the most current Terms of Use as published on this web site.