The following examples will help you validate that you are able to communicate with VolunteerHub's API. For creating and viewing HTTP request/response pairs we recommend a diagnostic tool called Fiddler that is available for the Windows platform. However, any tool that allows you to manipulate HTTP requests should be suitable.

In order to execute the following examples, first you'll need to compute your basic authentication credentials using the procedure detailed in Introduction to the VolunteerHub API.

Example 1

HTTP Request

Using Fiddler's Composer tool, create and execute the following HTTP Request:

GET https:///api/v1/organization
Authorization: basic 

HTTP Response

You should receive an HTTP response something like the following:

HTTP/1.1 200 OK
Cache-Control: no-cache
Pragma: no-cache
Content-Type: application/json; charset=utf-8
Expires: -1
Date: Tue, 16 Apr 2013 21:10:50 GMT
Content-Length: 450
{
  "ContactUserUid":"88fb2de6-ed13-451d-a2c9-7205cac19f66",
  "Name":"Test Organization",
  "Url":"www.volunteerhub.com",
  "Forms":
  [{
    "Name":"User Info",
    "FormQuestions":
    [{
      "FormQuestionUid":"6776c7aa-5a82-4a70-87da-3fdbcd6692d6",
      "Editability":"AdministratorsAndUsers",
      "FormQuestionType":"Name",
      "Name":"Full Name",
      "Ordinal":2,
      "Prompt":"Full Name",
      "Required":true,
      "SubPrompt":"First / Middle / Last",
      "Visibility":"AdministratorsAndUsers",
      "Tokens":
      [
        "UserName"
      ]
    }]
  }]
}
 

Example 2

HTTP Request

Using Fiddler's Composer tool, create and execute the following HTTP Request:

GET https:///api/v1/events?query=Version&earliestVersion=0
Authorization: basic 

Response

The query above will provide a basic list of events beginning with the earliest versions.

Example 3

HTTP Request

Using Fiddler's Composer tool, create and execute the following HTTP Request:

GET https:///v2/users?query=LastUpdate&earliestLastUpdate=1/1/2000 
Authorization: basic 

Response

The query above will provide a basic list of users beginning with those created/updated as of 1/1/2000.