PortfolioLinkApi

<back to all web services

GetProposals

Requires Authentication
The following routes are available for this service:
All Verbs/proposals
GetProposals Parameters:
NameParameterData TypeRequiredDescription
SearchTextquerystringNo
FilterStatusquerystringNo
PageNrqueryintNo
PageSizequeryintNo
PartnerIdqueryintNo
GetProposalsResponse Parameters:
NameParameterData TypeRequiredDescription
ResultformList<ProposalView>No
TotalRecordsformintNo
TotalPagesformintNo
CurrentPageNrformintNo
CurrentPageformintNo
ProposalView Parameters:
NameParameterData TypeRequiredDescription
UpdatedAsAtformDateTimeNo
ClientIdformintNo
ClientFullNameformstringNo
ClientIdNumberformstringNo
GoalTypeIdformintNo
GoalNameformstringNo
ClientGoalResultsIdformintNo
InputCurrentSavingsformdecimalNo
DocumentStatusformstringNo
TotalRecordsformintNo

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 /proposals HTTP/1.1 
Host: api.portfoliolink.co.za 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	searchText: String,
	filterStatus: String,
	pageNr: 0,
	pageSize: 0,
	partnerId: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	result: 
	[
		{
			updatedAsAt: 0001-01-01,
			clientId: 0,
			clientFullName: String,
			clientIdNumber: String,
			goalTypeId: 0,
			goalName: String,
			clientGoalResultsId: 0,
			inputCurrentSavings: 0,
			documentStatus: String,
			totalRecords: 0
		}
	],
	totalRecords: 0,
	totalPages: 0,
	currentPageNr: 0,
	currentPage: 0
}