Mokugift

mokugift rewards
The meaningful and effective way to motivate your customers

Rewards Home | How it works| How we plant| FAQ| Developer Center

Contact mokugift:

	415.508.6658

	sales@mokugift.com

	Contact Form


Developers Menu

	Mokugift API Home
	Mokugift Sandbox
	Login to access IDs & Passcodes

Mokugift API: Query Rewards for the Month

Description

This call would return the list of all Rewards created for the specified campaign in the specified month.

API version = 1.0

Request Information

EndPoint URL:	http://www.mokugift.com/api/rewards_in_month/<campaign_id>/<month>/<year>

HTTP Method:	GET

Request Parameters

Parameter	Value	Description
<campaign_id> (on URL)	String (required)	The unique ID for the reward campaign.
<month> (on URL)	Integer	The specified month {1..12}. If both month and year do not exist, it implies the current month & year.
<year> (on URL)	Integer	The specified year, eg. 2008. If both month and year do not exist, it implies the current month & year.

Sample Request 1: (current month)
http://www.mokugift.com/api/rewards_in_month/xxxxxxxxxx

Sample Request 2:
http://www.mokugift.com/api/rewards_in_month/xxxxxxxxxx/4/2008

Response Elements

Fields	Parent Field	Description
result	n/a	Root element that contain the whole response
version	result	Version of the Mokugift API.
status	result	Status of this call: *Success* or *Failed*.
summary	result	The summary of all activites for the campaign in the specified month.
reward_count	summary	The number of rewards created for the campaign in the specified month.
tree_count	summary	The number of trees planted for the campaign in the specified month.
rewards	result	This element contain all the rewards in the specified month.
reward	rewards	This element contain all the information of each reward.
id	reward	Unique ID of the reward.
date	reward	The date when the reward was created.
recipient_email	reward	The email of the recipient of the reward.
tree_count	reward	The number of trees planted for the reward.
error	result	Only when status=*Failed. Error Information: code & description. Please see Complete list of Errors*

Sample Response 1:
<xml version="1.0" standalone="yes"/> <result> <version>1.0</version> <status>Success</status> <summary> <reward_count>5</reward_count> <tree_count>5</tree_count> </summary> <rewards> <reward> <id>abcdefg1</id> <date>4/07/2008</date> <recipient_email>jonn@smith.com</recipient_email> <tree_count>1</tree_count> </reward> <reward> <id>abcdefg2</id> <date>4/05/2008</date> <recipient_email>bob@smith.com</recipient_email> <tree_count>1</tree_count> </reward> <reward> <id>abcdefg3</id> <date>4/03/2008</date> <recipient_email>bill@smith.com</recipient_email> <tree_count>1</tree_count> </reward> <reward> <id>abcdefg4</id> <date>4/03/2008</date> <recipient_email>jeff@smith.com</recipient_email> <tree_count>1</tree_count> </reward> <reward> <id>abcdefg5</id> <date>4/01/2008</date> <recipient_email>dave@smith.com</recipient_email> <tree_count>1</tree_count> </reward> </rewards> </result>

Sample Response 2: (Example error when <month>=13)
<xml version="1.0" standalone="yes"/> <result> <version>1.0</version> <status>Failed</status> <error> <code>113</code> <description>Invalid parameters</description> </error> </result>