PortfolioLinkApi

GetClientsV2

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

**GetClientsV2** Parameters:
Name	Parameter	Data Type	Required
SearchText	query	string	No
OrderBy	query	string	No
Order	query	string	No
PageNr	query	int	No
PageSize	query	int	No

**GetClientsV2Response** Parameters:
Name	Parameter	Data Type	Required
Result	form	List<ClientSearchView>	No
TotalRecords	form	int	No
TotalPages	form	int	No
CurrentPageNr	form	int	No
CurrentPage	form	int	No

**ClientSearchView** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
UserId	form	string	No
PartnerId	form	int	No
PrimaryEmail	form	string	No
SecondaryEmail	form	string	No
FirstName	form	string	No
MiddleNames	form	string	No
LastName	form	string	No
FullName	form	string	No
Alias	form	string	No
Phone	form	string	No
Mobile	form	string	No
IdNumber	form	string	No
Status	form	string	No
ClientType	form	string	No
Birthday	form	DateTime	No
CreatedAsAt	form	DateTime	No
UpdatedAsAt	form	DateTime	No
TotalRecords	form	int	No
Goals	form	List<ClientGoalsView>	No

**ClientGoalsView** Parameters:
Name	Parameter	Data Type	Required
UserId	form	string	No
PortfolioId	form	int	No
ClientId	form	int	No
ClientFullName	form	string	No
ClientIdNumber	form	string	No
ClientPrimaryEmail	form	string	No
ClientMobile	form	string	No
ClientGoalId	form	int	No
ClientGoalResultsId	form	int	No
GoalName	form	string	No
PortfolioName	form	string	No
Status	form	string	No
InputLifeExpectancyAge	form	int	No
InputCurrentSavingsDate	form	string	No
InputCurrentSavings	form	double	No
InputExpectedInflationRate	form	double	No
InputWithdrawalAmount	form	double	No
InputWithdrawalGrowthRate	form	double	No
CashReserve	form	double	No
AdditionalSaProperty	form	double	No
Results	form	Object	No
PartnerSettings	form	PartnerSettings	No

**PartnerSettings** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
Name	form	string	No
PartnerId	form	int	No
PartnerLogoUrl	form	string	No
PartnerBackgroundType	form	string	No
PartnerBackgroundUrl	form	string	No
ExpectedInflationRate	form	decimal	No
WithdrawalIncomeGrowthRate	form	decimal	No
Hellosignapikey	form	string	No
EnableCashReserve	form	bool	No
EnableProperty	form	bool	No
PartnerDefaultSettings	form	PartnerDefaultSettings	No
PartnerContactDetails	form	PartnerContactDetails	No

**PartnerDefaultSettings** Parameters:
Name	Parameter	Data Type	Required
SettingsId	form	int	No
PartnerId	form	int	No
PartnerName	form	string	No
AaType	form	string	No
ThemeId	form	int	No
InitialFee	form	decimal	No
AdvisorFee	form	decimal	No
PlatformFee	form	decimal	No
MoreLikelyZScore	form	decimal	No
LessLikelyZScore	form	decimal	No
ShowLowestProjectedOutcome	form	bool	No
IsFundAlphaEqualToFees	form	bool	No
ShowAdvisoryFees	form	bool	No
ShowCashflowTable	form	bool	No
XAxisLabel	form	string	No
AppearanceSettings	form	AppearanceSettings	No

**AppearanceSettings** Parameters:
Name	Parameter	Data Type	Required
AppearanceSchema	form	AppearanceSchema	No
ProjectedComponentName	form	string	No
ShowMedianOutcome	form	bool	No
MedianLineColor	form	string	No
BottomScenarioLineColor	form	string	No
ShowLowestProjectedOutcome	form	bool	No

**AppearanceSchema** Parameters:
Name	Parameter	Data Type	Required
FontColor	form	string	No
AxisColor	form	string	No
AxisGridColor	form	string	No
GraphColor	form	string	No
GraphColorOpacity	form	double	No
GraphColorRange2	form	string	No
GraphColorOpacity2	form	double	No
AverageLineColor	form	string	No
BarColor1	form	string	No
BarColor2	form	string	No
LogoHeight	form	string	No
LogoUrl	form	string	No
LogoBackground	form	string	No
TopBarBackground	form	string	No
TopBarFontColor	form	string	No
H2Color	form	string	No
LinkColor	form	string	No
ProposalBackgroundUrl	form	string	No
ProposalBackgroundUrl2	form	string	No
ProposalBackgroundUrl3	form	string	No
ProposalBackgroundUrl4	form	string	No

**PartnerContactDetails** Parameters:
Name	Parameter	Data Type	Required
Website	form	string	No
Email	form	string	No
Telephone	form	string	No
Fax	form	string	No
AddressLine1	form	string	No
AddressLine2	form	string	No
AddressLine3	form	string	No
AddressLine4	form	string	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 /v2/clients HTTP/1.1 
Host: api.portfoliolink.co.za 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	searchText: String,
	orderBy: String,
	order: String,
	pageNr: 0,
	pageSize: 0
}

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

{
	result: 
	[
		{
			id: 0,
			userId: String,
			partnerId: 0,
			primaryEmail: String,
			secondaryEmail: String,
			firstName: String,
			middleNames: String,
			lastName: String,
			fullName: String,
			alias: String,
			phone: String,
			mobile: String,
			idNumber: String,
			status: String,
			clientType: String,
			birthday: 0001-01-01,
			createdAsAt: 0001-01-01,
			updatedAsAt: 0001-01-01,
			totalRecords: 0,
			goals: 
			[
				{
					userId: String,
					portfolioId: 0,
					clientId: 0,
					clientFullName: String,
					clientIdNumber: String,
					clientPrimaryEmail: String,
					clientMobile: String,
					clientGoalId: 0,
					clientGoalResultsId: 0,
					goalName: String,
					portfolioName: String,
					status: String,
					inputLifeExpectancyAge: 0,
					inputCurrentSavingsDate: String,
					inputCurrentSavings: 0,
					inputExpectedInflationRate: 0,
					inputWithdrawalAmount: 0,
					inputWithdrawalGrowthRate: 0,
					cashReserve: 0,
					additionalSaProperty: 0,
					results: {},
					partnerSettings: 
					{
						id: 0,
						name: String,
						partnerId: 0,
						partnerLogoUrl: String,
						partnerBackgroundType: String,
						partnerBackgroundUrl: String,
						expectedInflationRate: 0,
						withdrawalIncomeGrowthRate: 0,
						hellosignapikey: String,
						enableCashReserve: False,
						enableProperty: False,
						partnerDefaultSettings: 
						{
							settingsId: 0,
							partnerId: 0,
							partnerName: String,
							aaType: String,
							themeId: 0,
							initialFee: 0,
							advisorFee: 0,
							platformFee: 0,
							moreLikelyZScore: 0,
							lessLikelyZScore: 0,
							showLowestProjectedOutcome: False,
							isFundAlphaEqualToFees: False,
							showAdvisoryFees: False,
							showCashflowTable: False,
							xAxisLabel: String,
							appearanceSettings: 
							{
								appearanceSchema: 
								{
									fontColor: String,
									axisColor: String,
									axisGridColor: String,
									graphColor: String,
									graphColorOpacity: 0,
									graphColorRange2: String,
									graphColorOpacity2: 0,
									averageLineColor: String,
									barColor1: String,
									barColor2: String,
									logoHeight: String,
									logoUrl: String,
									logoBackground: String,
									topBarBackground: String,
									topBarFontColor: String,
									h2Color: String,
									linkColor: String,
									proposalBackgroundUrl: String,
									proposalBackgroundUrl2: String,
									proposalBackgroundUrl3: String,
									proposalBackgroundUrl4: String
								},
								projectedComponentName: String,
								showMedianOutcome: False,
								medianLineColor: String,
								bottomScenarioLineColor: String,
								showLowestProjectedOutcome: False
							}
						},
						partnerContactDetails: 
						{
							website: String,
							email: String,
							telephone: String,
							fax: String,
							addressLine1: String,
							addressLine2: String,
							addressLine3: String,
							addressLine4: String
						}
					}
				}
			]
		}
	],
	totalRecords: 0,
	totalPages: 0,
	currentPageNr: 0,
	currentPage: 0
}