Public Mentoring Accounts

This is an optional module of Hyper CRM. When you want to host some mentoring accounts that can be real live accounts on your TP, or hosted accounts on third party TP Demo / Live server.
The concept is that you expose your clients to these accounts and allow them to get Signaling (email / sms) on every action done in these accounts.
Please note: This module is not included in the standard package and requires additional payment !
The CRM settings for this module are based on "hyp_Clients Record Extension" table. Please refer to the CRM Setup section below.
After you setup the system, call the Mentoring_Accounts_List_json function, for the mentoring/investment accounts list.
For each account, you can call Return_Report_json function, for getting the account Trading Performance data sheet.

CRM Setup for this module

Please define the following fields on your Hyper CRM table: "hyp_Clients Record Extension".
The English field title (name) is mandatory and must be exact as described here. All other languages can be freely configured.
Custom Field Title Data Type Description
Mentoring Account Status This is the triggering field, tells the system whether to include an account in the mentoring module.
0:None - Normal Client
1:Investment Robot
2:Investment Robot & Mentoring
3:Mentoring Account
As for every status type field, the text itself does not matter for the system, only the values order and amount !
Display Order Integer How to sort the accounts on the HTML / Json result. Simple sorting from Low to High. You can insert values that are not sequential...
Minimum Investment USD Integer This field will be displayed on the HTML / Json result, AND also be verified when depositing money for investment.
Monthly Fee USD Money The price of Signaling service, per month in USD currency.
Executive Summary String (TextMemo) This text will be presented on the HTML / Json result and has no effect on the module.
Investment New TP Account Group String When opening the new TP account, this group will be requested.
It is recommended to configure this field as simple EDIT and just "copy-paste" the right group name.

Mentoring Accounts List

Call the Mentoring_Accounts_List_json function with "type" parameter, which is a filter:
DOMAIN/Mentoring_Accounts_List_json?type=mentoring
DOMAIN/Mentoring_Accounts_List_json?type=investment
DOMAIN/Mentoring_Accounts_List_json?type=all

API Possible Error Messages

Code Content
3 API function does not exists.
4 Database Error on server side.
5 Technical Error on server side.
6 Technical Error: Client Session not found.

API Report Output

{
  "RowCount": "2",
  "Data": [
    {
      "ClientNumber": "500013",
      "AccountName": "Something Special",
      "TPLogin": "123456",
      "MentoringAccount": "2",
      "DisplayOrder": "2",
      "MinimumInvestmentUSD": "3000",
      "MonthlyFeeUSD": "14.00",
      "ExecutiveSummary": "This is a long story...",
      "Registered": "0"
    },
    {
      "ClientNumber": "500015",
      "AccountName": "Hard work pay off ?",
      "TPLogin": "20465703",
      "MentoringAccount": "2",
      "DisplayOrder": "4",
      "MinimumInvestmentUSD": "3000",
      "MonthlyFeeUSD": "22.00",
      "ExecutiveSummary": "This is a long story - again",
      "Registered": "1"
    }
  ]
}

Mentoring Account - Closed Trades List

Call the Mentoring_Closed_Trades_json function with "For_TP_Login" OR "For_Client_Number" parameter.
It will response with the last 30 days closed positions, in the object "List".
Pay attention to the object "PageTitles" which contain some interesting information about the Mentor:
Field Description
TradingAssets How many unique assets have been traded for the last 30 days.
LiveMembers How many people are following this mentor.
ClosedTrades How many closed trades are in the list (for the last 30 days).
Currency_Trading_Profit_Pips This field sum all "Currency Pairs" trades Price Shifts, regarding the volume (amount) of each trade, and presenting industry standard "Profit in Pips".
Trial IF the connected user has paid for this mentor, then this field value is "No" and you will get all data in real time.
IF the value is "Yes", then the report will contain from day -30 up-to -1, meaning you miss closed trades from the last 24 hours.
* Please note that "OpenTime" and "CloseTime" values are in UTC.
Example of calling the report:
DOMAIN/Mentoring_Accounts_List_json?For_TP_Login=123456
Example of Report Output:
{
  "List": {
    "RowCount": "489",
    "Data": [
      {
        "OpenTime": "25/08/2017 16:00:00",
        "CloseTime": "28/08/2017 07:30:03",
        "Symbol": "EUR/USD",
        "Command": "SELL",
        "TradePLInPips": "-0.01322",
        "OpenPrice": "1.17961",
        "ClosePrice": "1.19283",
        "StopLoss": "0",
        "TakeProfit": "0"
      } // here there will be another 488 records...
    ]
  },
  "PageTitles": {
    "TradingAssets": "4",
    "LiveMembers": "65",
    "ClosedTrades": "489",
    "Currency_Trading_Profit_Pips": "-13.48965",
    "Trial": "No"
  }
}

Mentoring Account - Live Open Trades List

Call the Mentoring_Open_Trades_json function with "For_TP_Login" OR "For_Client_Number" parameter.
It will response with the current open positions, in the object "List".
Pay attention to the object "PageTitles" which contain some interesting information about the Mentor:
Field Description
TradingAssets How many unique assets exist in the open positions list.
LiveMembers How many people are following this mentor.
OpenTrades How many open trades are in the list.
Currency_Trading_Profit_Pips This field sum all "Currency Pairs" trades Price Shifts, regarding the volume (amount) of each trade, and presenting industry standard "Profit in Pips".
This value expected to be modified every 60 seconds.
* Please note that "OpenTime" value is in UTC.
Example of calling the report:
DOMAIN/Mentoring_Open_Trades_json?For_TP_Login=123456
Example of Report Output:
{
  "List": {
    "RowCount": "2",
    "Data": [
      {
        "OpenTime": "27/08/2017 01:00:00",
        "Symbol": "USD/JPY",
        "Command": "SELL",
        "StopLoss": "0",
        "TakeProfit": "0",
        "OpenPrice": "112.405",
        "TradePLInPips": "0.056"
      },
      {
        "OpenTime": "26/08/2017 18:30:05",
        "Symbol": "USD/CHF",
        "Command": "BUY",
        "StopLoss": "0",
        "TakeProfit": "0",
        "OpenPrice": "0.96929",
        "TradePLInPips": "0.00142"
      }
    ]
  },
  "PageTitles": {
    "TradingAssets": "2",
    "LiveMembers": "52",
    "OpenTrades": "2",
    "Currency_Trading_Profit_Pips": "0.05742"
  }
}

Get Last Signals list from all subscribed mentoring accounts

Call the Mentoring_Last_Signals_json function without parameters.
It will response with the Last Signals, from all subscribed mentoring accounts (by the connected user), in the object "List".