Skip to content
This repository has been archived by the owner on Mar 30, 2021. It is now read-only.

API Footprint

Jump to bottom
Noufal Ibrahim edited this page Nov 28, 2013 · 6 revisions

Basic Objects

Any slot that is not yet implemented will be "not implemented"

User

{
  id: 0,
  username: '',
  fullname: '',
  avatar: {url},
  email: '',
  twitter: '',
  authService: 0,
  lastLogin: new Date(),
  created: new Date(),
  campaigns: [],
  currency: 'INR'
}

Campaign

{
  id: 0,
  name: '',
  subheading: '',
  brief: '',
  description: '<html>',
  latlng: [lat, lng],
  gallery: [{
    heading: '',
    description: '',
    url: {url},
    alt: '',
    verified: true
  }],
  start: new Date(),
  end: new Date(),
  pledged: 0,
  target: 0
  email: '',
  twitter: '',
  authService: 0,
  approvedBy: user.id,
  approvedOn: new Date()
  verifiedBy: user.id,
  verifiedOn: new Date()
}

Category

{
  id: 0,
  name: '',
  icon: 'cssClass',
  campaigns: [{campaign}]
}

Location

{
  id: 0,
  name: '',
  photo: {url},
  latlng: [lat, lng],
  campaigns: [{campaign}]
}

API Methods

/auth/signin Authenticate users and create a session if the provided credentials match.

/auth/signout Destroy the session and sign users out

/user/create Create users

/user/:id View a user's profile by ID

/user/:id/modify Modify a user's profile by ID

/user/:id/delete Delete a user's profile by ID

/search/:query Search all resources by Query

/campaign/create Create a campaign

/campaign/modify/:id Modify a campaign by ID

/campaign/delete/:id Delete a campaign by ID

/campaign/list List all campaigns

/campaign/featured List all featured campaigns

/category/list List all categories

/category/:name List all campaigns in a category by name

/category/featured List all featured categories

/location/list List all locations

/location/:name List all campaigns in a location by name

/location/featured List all featured locations

/search Search is described on a separate page.

Clone this wiki locally