FxHubPartnersApi

Report

The following routes are available for this service:
All Verbs	/report

**Report** Parameters:
Name	Parameter	Data Type	Required	Description
StartDate	query	DateTime	No
EndDate	query	DateTime	No

**ReportResponse** Parameters:
Name	Parameter	Data Type	Required
ResponseStatus	form	ResponseStatus	No
MonthlyRetailData	form	List<RetailData>	No
QuarterlyRetailData	form	List<RetailData>	No
YearlyRetailData	form	List<RetailData>	No
MonthlyStagingData	form	List<StagingData>	No
QuarterlyStagingData	form	List<StagingData>	No
YearlyStagingData	form	List<StagingData>	No
TotalRetailDataPerPartner	form	List<RetailData>	No

**RetailData** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
Name	form	string	No
Date	form	DateTime	No
NumberClients	form	int	No
NumberTrades	form	int	No
Profit	form	decimal	No
NumberTccs	form	int	No

**StagingData** Parameters:
Name	Parameter	Data Type	Required
PartnerId	form	int	No
Cif	form	int	No
Name	form	string	No
Date	form	DateTime	No
NumberTrades	form	int	No
Profit	form	decimal	No
ZarNominal	form	decimal	No

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /report HTTP/1.1 
Host: api.fxlink.co.za 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	startDate: 0001-01-01,
	endDate: 0001-01-01
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	},
	monthlyRetailData: 
	[
		{
			id: 0,
			name: String,
			date: 0001-01-01,
			numberClients: 0,
			numberTrades: 0,
			profit: 0,
			numberTccs: 0
		}
	],
	quarterlyRetailData: 
	[
		{
			id: 0,
			name: String,
			date: 0001-01-01,
			numberClients: 0,
			numberTrades: 0,
			profit: 0,
			numberTccs: 0
		}
	],
	yearlyRetailData: 
	[
		{
			id: 0,
			name: String,
			date: 0001-01-01,
			numberClients: 0,
			numberTrades: 0,
			profit: 0,
			numberTccs: 0
		}
	],
	monthlyStagingData: 
	[
		{
			partnerId: 0,
			cif: 0,
			name: String,
			date: 0001-01-01,
			numberTrades: 0,
			profit: 0,
			zarNominal: 0
		}
	],
	quarterlyStagingData: 
	[
		{
			partnerId: 0,
			cif: 0,
			name: String,
			date: 0001-01-01,
			numberTrades: 0,
			profit: 0,
			zarNominal: 0
		}
	],
	yearlyStagingData: 
	[
		{
			partnerId: 0,
			cif: 0,
			name: String,
			date: 0001-01-01,
			numberTrades: 0,
			profit: 0,
			zarNominal: 0
		}
	],
	totalRetailDataPerPartner: 
	[
		{
			id: 0,
			name: String,
			date: 0001-01-01,
			numberClients: 0,
			numberTrades: 0,
			profit: 0,
			numberTccs: 0
		}
	]
}