TMC API DOCUMENTATION for asp.net

I. TMC_API.CreateConversationWithFormData Method

public int CreateConversationWithFormData(
FormData data
)
Parameters
data
Type: FormData
Implements
ITMC_API.CreateConversationWithFormData

II. TMC_API.CreateConversationWithMessageInCommunity Method

public Conversation CreateConversationWithMessageInCommunity(
Message message,
string communityID
)
Parameters
messageID
Type: string
message
Type: Message
Implements
ITMC_API.ReplyToMessage

III. TMC_API.alive Method

public bool alive()
Implements
ITMC_API.alive

IV. TMC_API.lookupClientByClientID Method

public Client lookupClientByClientID(
string clientID
)
Parameters
clientID
Type: string
Implements
ITMC_API.lookupClientByClientID

V. TMC_API.lookupCommunitiesByClientID Method

public List<Community> lookupCommunitiesByClientID(
string clientID
)
Parameters
clientID
Type: string
Implements
ITMC_API.lookupCommunitiesByClientID

VI. TMC_API.lookupCommunityByCommunityID Method

public Community lookupCommunityByCommunityID(
string communityID
)
Parameters
communityID
Type: string
Implements
ITMC_API.lookupCommunityByCommunityID

VII. TMC_API.lookupConversationByConversationID Method

public Conversation lookupConversationByConversationID(
string conversationID
)
Parameters
conversationID
Type: string
Implements
ITMC_API.lookupConversationByConversationID

VIII. TMC_API.lookupConversationsByMenteeEmail Method

public List<ConversationHeader> lookupConversationsByMenteeEmail(
string email
)
Parameters
email
Type: string
Implements
ITMC_API.lookupConversationsByMenteeEmail

IX. TMC_API.lookupConversationsByUserID Method

public List<ConversationHeader> lookupConversationsByUserID(
string userID
)
Parameters
userID
Type: string
Implements
ITMC_API.lookupConversationsByUserID

X. TMC_API.lookupMessageByMessageID Method

public Message lookupMessageByMessageID(
string messageID
)
Parameters
messageID
Type: string
Implements
ITMC_API.lookupMessageByMessageID

XI. TMC_API.lookupMessagesByConversationID Method

public List<Message> lookupMessagesByConversationID(
string conversationID
)
Parameters
conversationID
Type: string
Implements
ITMC_API.lookupMessagesByConversationID

XII. TMC_API.lookupUserByUserID Method

public User lookupUserByUserID(
string userID
)
Parameters
userID
Type: string
Implements
ITMC_API.lookupUserByUserID

XIII. TMC_API.lookupUsersByCommunityID Method

public List<User> lookupUsersByCommunityID(
string communityID
)
Parameters
communityID
Type: string
Implements
ITMC_API.lookupUsersByCommunityID

XIV. TMC_API.status Method

Implements
ITMC_API.status

HOW TO CALL THE API WEB SERVICES

INVOKE METHODS AND OPERATION CONTRACTS
//Miscellaneous

[WebInvoke(Method = "GET", UriTemplate = "alive/")]
[OperationContract]
Boolean alive();

[WebInvoke(Method = "GET", UriTemplate = "status/")]
[OperationContract]
SystemStatus status();

//Account Services
[WebInvoke(Method = "GET", UriTemplate = "clients/{clientID}")]
[OperationContract]
Client lookupClientByClientID(String clientID);

//Conversation
[WebInvoke(Method = "PUT", UriTemplate = "community/{communityID}/conversations", RequestFormat =
WebMessageFormat.Xml, ResponseFormat = WebMessageFormat.Xml)]
[OperationContract]
Conversation CreateConversationWithMessageInCommunity(Message message, String communityID);

Example:
WebChannelFactory<ITMC_API> cf = new WebChannelFactory<ITMC_API(token)>(
new Uri(“https://api.thementorcenter.com/TMC_API.svc”));
ITMC_API channel = cf.CreateChannel();
Conversation cvs =
channel.CreateConversationWithMessageInCommunity(Message,communityID);

[WebInvoke(Method = "PUT", UriTemplate = "messages/{messageID}", RequestFormat = WebMessageFormat.Xml,
ResponseFormat = WebMessageFormat.Xml)]
[OperationContract]
Conversation ReplyToMessage(String messageID, Message message);

Example:
WebChannelFactory<ITMC_API> cf = new WebChannelFactory<ITMC_API(token)>(
new Uri(“https://api.thementorcenter.com/TMC_API.svc”));
ITMC_API channel = cf.CreateChannel();
Conversation cvs = channel.ReplyToMessage (messageID,message);

[WebInvoke(Method = "PUT", UriTemplate = "formdata", RequestFormat = WebMessageFormat.Xml,
ResponseFormat = WebMessageFormat.Xml)]
[OperationContract]
int CreateConversationWithFormData(FormData data);

Example:
WebChannelFactory<ITMC_API> cf = new WebChannelFactory<ITMC_API(token)>(
new Uri(“https://api.thementorcenter.com/TMC_API.svc”));
ITMC_API channel = cf.CreateChannel();
int flag = channel.CreateConversationWithFormData(FormData);

//Entity Lookup

[WebInvoke(Method = "GET", UriTemplate = "conversations/{conversationID}")]
[OperationContract]
Conversation lookupConversationByConversationID(String conversationID);

Example:
WebChannelFactory<ITMC_API> cf = new WebChannelFactory<ITMC_API(token)>(
new Uri(“https://api.thementorcenter.com/TMC_API.svc”));
ITMC_API channel = cf.CreateChannel();
conversation cvs =
channel.lookupConversationByConversationID(conversationID);
[WebInvoke(Method = "GET", UriTemplate = "users/{userID}/conversations")]
[OperationContract]
List<ConversationHeader> lookupConversationsByUserID(String userID);

Example:
WebChannelFactory<ITMC_API> cf = new WebChannelFactory<ITMC_API(token)>(
new Uri(“https://api.thementorcenter.com/TMC_API.svc”));
ITMC_API channel = cf.CreateChannel();
List<ConversationHeader> cvs =
channel.lookupConversationsByUserID(userID);
[WebInvoke(Method = "GET", UriTemplate = "mentees/{email}/conversations")]
[OperationContract]
List<ConversationHeader> lookupConversationsByMenteeEmail(String email);

Example:
WebChannelFactory<ITMC_API> cf = new WebChannelFactory<ITMC_API(token)>(
new Uri(“https://api.thementorcenter.com/TMC_API.svc”));
ITMC_API channel = cf.CreateChannel();
List<ConversationHeader> cvs =
channel. lookupConversationsByMenteeEmail(email);
[WebInvoke(Method = "GET", UriTemplate = "messages/{messageID}")]
[OperationContract]
Message lookupMessageByMessageID(String messageID);