|
Method
|
Description
|
Return type
|
|
|
|
GetGoalList
|
This extracts the general specs about the Goal(s) that any specific user is subscribed
to. The following fields will be returned.
Goal ID
USERID – Goal Subscriber/User
ID
Title – Title of
the Goal.
Overview – Detailed
description of the Goal.
Topicname - Topic
Startdate – Date
the Goal begins.
Enddate – Date
the Goal ends.
Frequencytext–
Frequency required to performance evaluation
Audiencetext –
Audience
GoalTags – Goal
Tags
GoaltypeText –
Individual Goal or Team Goal
Status – Goal Status
(Pending or Commenced)
ImageID – Goal
Image ID
Imagename - Goal
Image URL
|
XML
Parameters:
Email (String), Password (String), DeveloperKey (String)
|
Click here for code block example (how to...)
Add Web Reference to your project and use http://mecanbe.com/goalapi.asmx
Use a suitable name. Here I have used "com.mecanbe.services".
Example
Declare and Initialize the Webservice
com.mecanbe.services.goalapi apiService = new mecanbe.com.mecanbe.services.goalapi();
Method to cosume: GetGoalList
XmlDocument xDoc = apiService.GetGoalList("email", "password", "api-key");
Please note: you have to supply the values for email, password and api-key (String)
Use InnerXML and iterate through nodes
Complte code block exapmle
public partial class demo_default : System.Web.UI.Page
{
com.mecanbe.services.goalapi apiService = new mecanbe.com.mecanbe.services.goalapi();
protected void Page_Load(object sender, EventArgs e)
{
if(!Page.IspostBack)
{
XmlDocument xDoc = apiService.GetGoalList("email",
"password", "api-key");
GridView1.DataSource = xDoc;
GridView1.DataBind();
}
}
}
|
|
|
|
GetRatingHistory
|
This extracts the historical performance evaluation ratings given by a specific
user for all Tasks in their subscribed Goals.
GoalTaskID – Task
ID
GoalID – Goal ID
RatingID – Rating
ID
Rating – Rating
given by user for for specific Task within specific Goal.
RateBy - Who has
given the rating
RatedOn - Date/Time
stamp for rating.
|
XML
|
Click here for code block example (how to...)
Add Web Reference to your project and use http://mecanbe.com/goalapi.asmx
Use a suitable name. Here I have used "com.mecanbe.services".
Example
Declare and Initialize the Webservice
com.mecanbe.services.goalapi apiService = new mecanbe.com.mecanbe.services.goalapi();
Method to cosume: GetRatingHistory
XmlDocument xDoc = apiService.GetRatingHistory("email",
"api-key");
Please note: you have to supply the values for email, api-key
Use InnerXML and iterate through nodes
Complte code block exapmle
public partial class demo_default : System.Web.UI.Page
{
com.mecanbe.services.goalapi apiService = new mecanbe.com.mecanbe.services.goalapi();
protected void Page_Load(object sender, EventArgs e)
{
if(!Page.IspostBack)
{
XmlDocument xDoc = apiService.GetRatingHistory("email",
"api-key");
GridView1.DataSource = xDoc;
GridView1.DataBind();
}
}
}
|
|
|
|
GetTaskDetails
|
This extracts the tasks and task categories included in those Goals
that any specific user is subscribed to.
GoalListID – Goal
ID CategoryID – Task Category ID CategoryName
– Task Category Name
TaskID – Task ID
TaskName – Task
name.
TaskDescription
– Description of the task.
|
XML
|
Click here for code block example (how to...)
Add Web Reference to your project and use http://mecanbe.com/goalapi.asmx
Use a suitable name. Here I have used "com.mecanbe.services".
Example
Declare and Initialize the Webservice
com.mecanbe.services.goalapi apiService = new mecanbe.com.mecanbe.services.goalapi();
Method to cosume: GetTaskDetails
XmlDocument xDoc = apiService.GetTaskDetails("email",
"api-key");
Please note: you have to supply the values for email and api-key
Use InnerXML and iterate through nodes
Complte code block exapmle
public partial class demo_default : System.Web.UI.Page
{
com.mecanbe.services.goalapi apiService = new mecanbe.com.mecanbe.services.goalapi();
protected void Page_Load(object sender, EventArgs e)
{
if(!Page.IspostBack)
{
XmlDocument xDoc = apiService.GetTaskDetails("email",
"api-key");
GridView1.DataSource = xDoc;
GridView1.DataBind();
}
}
}
|
|
|
|
AddRatingToGoal
|
This adds a performance-evaluation rating to a task within a goal list that
the user is subscribed to.
Email – email of
goal subscriber
Password – password
of goal subscriber
TaskID – Task ID
GoalID – Goal ID
Rating – 2-10 Qualitative
Rating given by user for specific task.
|
String
|
|
|
Click here for code block example (how to...)
Add Web Reference to your project and use http://mecanbe.com/goalapi.asmx
Use a suitable name. Here I have used "com.mecanbe.services".
Example
Declare and Initialize the Webservice
com.mecanbe.services.goalapi apiService = new mecanbe.com.mecanbe.services.goalapi();
Method to cosume: AddRatingToGoal
XmlDocument xDoc = apiService.AddRatingToGoal("api-key",
"email", "password", "goalid", "taskid", "rating-value");
Please note: you have to supply the values for email and api-key
Use InnerXML and iterate through nodes
Complte code block exapmle
public partial class demo_default : System.Web.UI.Page
{
com.mecanbe.services.goalapi apiService = new mecanbe.com.mecanbe.services.goalapi();
protected void Page_Load(object sender, EventArgs e)
{
if(!Page.IspostBack)
{
XmlDocument xDoc = apiService.AddRatingToGoal("api-key",
"email", "password", "goalid", "taskid", "rating-value");
}
}
}
There are four possible results
1) If no combination is found with the supplied "GoalId" and "TaskId" output will
say "No combination with supplied goal and task has been found".
2) If you are not a subscriber, output will alert you with the message "To rate
a goal you must subscribe to it".
3) If you are a subscriber and trying to rate a goal more than once a day output
will alert you with the message "You can rate a goal only once a day"
4) If 1, 2 and 3 are passed successfully, output will confirm the user with "Rating
Added Successfully!" mesage.
|
|
AddQMToGoal
|
Lets user add / update the quantative measurement for a goal fo a particular
date. Such goal must have Quantitative Measurement on.
|
XML
|
|
|
Click here for code block example (how to...)
Add Web Reference to your project and use http://mecanbe.com/goalapi.asmx
Use a suitable name. Here I have used "com.mecanbe.services".
Example
Declare and Initialize the Webservice
com.mecanbe.services.goalapi apiService = new mecanbe.com.mecanbe.services.goalapi();
Method to cosume: AddQMToGoal
XmlDocument xDoc = apiService.AddQMToGoal("api-key",
"email", "password", "GoalID", "QM");
Please note: you have to supply the values for email and api-key
Use InnerXML and iterate through nodes
Complte code block exapmle
public partial class demo_default : System.Web.UI.Page
{
com.mecanbe.services.goalapi apiService = new mecanbe.com.mecanbe.services.goalapi();
protected void Page_Load(object sender, EventArgs e)
{
if(!Page.IspostBack)
{
XmlDocument xDoc = apiService.AddQMToGoal("api-key",
"email", "password", "GoalID", "QM");
}
}
}
There are six possible results
1) You are not authorized to update this goal!
2) There is no evaluation information found for you for this date!
3) You cannot change or update a goal more than once when it is completed!
4) Quantitaive evaluation is ot supported for this goal.
5) Value is out of range. Acceptable range: [Min range] - [Max range].
6) Your rating has been saved thr this goal.
|
|
ShowGoalQMForGivenDate
|
Lets user find out the Quantitative rating for a goal on a particular date given
by a specific subscriber of that goal. Following fields are returned.
GoalID - Goal ID
QMValue - Quantitative
rating for that day
Date - Date when
this rating was given
UserID - Who has
rated
|
XML
|
|
|
Click here for code block example (how to...)
Add Web Reference to your project and use http://mecanbe.com/goalapi.asmx
Use a suitable name. Here I have used "com.mecanbe.services".
Example
Declare and Initialize the Webservice
com.mecanbe.services.goalapi apiService = new mecanbe.com.mecanbe.services.goalapi();
Method to cosume: ShowGoalQMForGivenDate
XmlDocument xDoc = apiService.ShowGoalQMForGivenDate("api-key",
"GoalID", "userId", startDate);
Please note: you have to supply the values for email and api-key
Use InnerXML and iterate through nodes
Complte code block exapmle
public partial class demo_default : System.Web.UI.Page
{
com.mecanbe.services.goalapi apiService = new mecanbe.com.mecanbe.services.goalapi();
protected void Page_Load(object sender, EventArgs e)
{
if(!Page.IspostBack)
{
XmlDocument xDoc = apiService.ShowGoalQMForGivenDate("api-key",
"GoalID", "userId", startDate);
}
}
}
There are two possible results
1) This goal does not support quatitative evaluation (If Qualitative Measurement
is not supported by the goal)
2) List of values
Note: startDate parameter is a DateTime parameter. You have to
pass DateTime value for this.
|
|
ShowGoalQMForGivenDates
|
Lets user find out the Quantitative rating for a goal in a given date range
given by a specific subscriber of that goal. Following fields are returned.
GoalID - Goal ID
QMValue - Quantitative
rating for that day
Date - Date when
this rating was given
UserID - Who has
rated
|
XML
|
|
|
Click here for code block example (how to...)
Add Web Reference to your project and use http://mecanbe.com/goalapi.asmx
Use a suitable name. Here I have used "com.mecanbe.services".
Example
Declare and Initialize the Webservice
com.mecanbe.services.goalapi apiService = new mecanbe.com.mecanbe.services.goalapi();
Method to cosume: ShowGoalQMForGivenDates
XmlDocument xDoc = apiService.ShowGoalQMForGivenDates("api-key",
"GoalID", "userId", startDate, endDate);
Please note: you have to supply the values for email and api-key
Use InnerXML and iterate through nodes
Complte code block exapmle
public partial class demo_default : System.Web.UI.Page
{
com.mecanbe.services.goalapi apiService = new mecanbe.com.mecanbe.services.goalapi();
protected void Page_Load(object sender, EventArgs e)
{
if(!Page.IspostBack)
{
XmlDocument xDoc = apiService.ShowGoalQMForGivenDates("api-key",
"GoalID", "userId", startDate, endDate);
}
}
}
There are two possible results
1) This goal does not support quatitative evaluation (If Qualitative Measurement
is not supported by the goal)
2) List of values
Note: both startDate and endDate parameters are DateTime types.
You have to pass DateTime value for those.
|
|
ShowAverageQMForGivenDates
|
Returns the average value for Quantitative Measurement within a specified date
range.
|
XML
|
|
|
Click here for code block example (how to...)
Add Web Reference to your project and use http://mecanbe.com/goalapi.asmx
Use a suitable name. Here I have used "com.mecanbe.services".
Example
Declare and Initialize the Webservice
com.mecanbe.services.goalapi apiService = new mecanbe.com.mecanbe.services.goalapi();
Method to cosume: ShowAverageQMForGivenDates
XmlDocument xDoc = apiService.ShowAverageQMForGivenDates("api-key",
"userid", "GoalID", startDate, endDate);
Please note: you have to supply the values for email and api-key
Use InnerXML and iterate through nodes
Complte code block exapmle
public partial class demo_default : System.Web.UI.Page
{
com.mecanbe.services.goalapi apiService = new mecanbe.com.mecanbe.services.goalapi();
protected void Page_Load(object sender, EventArgs e)
{
if(!Page.IspostBack)
{
XmlDocument xDoc = apiService.ShowAverageQMForGivenDates("api-key",
"userid", "GoalID", startDate, endDate);
}
}
}
There are three possible results
1) This goal does not support quatitative evaluation (If Qualitative Measurement
is not supported by the goal)
2) User is not a subscriber of this goal
3) User has no evaluaton due for this goal in the given range of time
Note: both startDate and endDate parameters are DateTime types.
You have to pass DateTime value for those.
|
|
ValidateUser
|
Returns login status.
|
Boolean
|
|
|
Click here for code block example (how to...)
Add Web Reference to your project and use http://mecanbe.com/goalapi.asmx
Use a suitable name. Here I have used "com.mecanbe.services".
Example
Declare and Initialize the Webservice
com.mecanbe.services.goalapi apiService = new mecanbe.com.mecanbe.services.goalapi();
Method to cosume: validateUser
XmlDocument xDoc = apiService.validateUser("email",
"password");
Complte code block exapmle
public partial class demo_default : System.Web.UI.Page
{
com.mecanbe.services.goalapi apiService = new mecanbe.com.mecanbe.services.goalapi();
protected void Page_Load(object sender, EventArgs e)
{
if(!Page.IspostBack)
{
XmlDocument xDoc = apiService.validateUser("email",
"password");
}
}
}
There are two possible results
1) True (if the user is validated)
1) False (if the user is not validated)
|
|
GoalEvaluationCompleteForToday
|
Lets user know whether an Evaluation is "Completed" for current date
|
XML
|
|
|
Click here for code block example (how to...)
Add Web Reference to your project and use http://mecanbe.com/goalapi.asmx
Use a suitable name. Here I have used "com.mecanbe.services".
Example
Declare and Initialize the Webservice
com.mecanbe.services.goalapi apiService = new mecanbe.com.mecanbe.services.goalapi();
Method to cosume: GoalEvaluationCompleteForToday
XmlDocument xDoc = apiService.GoalEvaluationCompleteForToday("goalListId",
"userId");
Complte code block exapmle
public partial class demo_default : System.Web.UI.Page
{
com.mecanbe.services.goalapi apiService = new mecanbe.com.mecanbe.services.goalapi();
protected void Page_Load(object sender, EventArgs e)
{
if(!Page.IspostBack)
{
XmlDocument xDoc = apiService.GoalEvaluationCompleteForToday("goalListId",
"userId");
}
}
}
|
|
GoalEvaluationCompleteForGivenDate
|
Lets user know whether an Evaluation is "Completed" for a given date range
|
XML
|
|
|
Click here for code block example (how to...)
Add Web Reference to your project and use http://mecanbe.com/goalapi.asmx
Use a suitable name. Here I have used "com.mecanbe.services".
Example
Declare and Initialize the Webservice
com.mecanbe.services.goalapi apiService = new mecanbe.com.mecanbe.services.goalapi();
Method to cosume: GoalEvaluationCompleteForGivenDate
XmlDocument xDoc = apiService.GoalEvaluationCompleteForGivenDate("goalListId",
"userId", "defDate");
Complte code block exapmle
public partial class demo_default : System.Web.UI.Page
{
com.mecanbe.services.goalapi apiService = new mecanbe.com.mecanbe.services.goalapi();
protected void Page_Load(object sender, EventArgs e)
{
if(!Page.IspostBack)
{
XmlDocument xDoc = apiService.GoalEvaluationCompleteForGivenDate("goalListId",
"userId", "defDate");
}
}
}
|
|
ComponentVersionInfo
|
Lets user get current component version
|
XML
|
|
|
Click here for code block example (how to...)
Add Web Reference to your project and use http://mecanbe.com/goalapi.asmx
Use a suitable name. Here I have used "com.mecanbe.services".
Example
Declare and Initialize the Webservice
com.mecanbe.services.goalapi apiService = new mecanbe.com.mecanbe.services.goalapi();
Method to cosume: ComponentVersionInfo
XmlDocument xDoc = apiService.ComponentVersionInfo();
Complte code block exapmle
public partial class demo_default : System.Web.UI.Page
{
com.mecanbe.services.goalapi apiService = new mecanbe.com.mecanbe.services.goalapi();
protected void Page_Load(object sender, EventArgs e)
{
if(!Page.IspostBack)
{
XmlDocument xDoc = apiService.ComponentVersionInfo();
}
}
}
|