PortfolioLinkApi

GetProposals

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

**GetProposals** Parameters:
Name	Parameter	Data Type	Required
SearchText	query	string	No
FilterStatus	query	string	No
PageNr	query	int	No
PageSize	query	int	No
PartnerId	query	int	No

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

**ProposalView** Parameters:
Name	Parameter	Data Type	Required
UpdatedAsAt	form	DateTime	No
ClientId	form	int	No
ClientFullName	form	string	No
ClientIdNumber	form	string	No
GoalTypeId	form	int	No
GoalName	form	string	No
ClientGoalResultsId	form	int	No
InputCurrentSavings	form	decimal	No
DocumentStatus	form	string	No
TotalRecords	form	int	No

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

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<GetProposals xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PortfolioLinkApi.ServiceModel">
  <FilterStatus>String</FilterStatus>
  <PageNr>0</PageNr>
  <PageSize>0</PageSize>
  <PartnerId>0</PartnerId>
  <SearchText>String</SearchText>
</GetProposals>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetProposalsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PortfolioLinkApi.ServiceModel">
  <CurrentPage>0</CurrentPage>
  <CurrentPageNr>0</CurrentPageNr>
  <Result xmlns:d2p1="http://schemas.datacontract.org/2004/07/SharedTypes">
    <d2p1:ProposalView>
      <d2p1:ClientFullName>String</d2p1:ClientFullName>
      <d2p1:ClientGoalResultsId>0</d2p1:ClientGoalResultsId>
      <d2p1:ClientId>0</d2p1:ClientId>
      <d2p1:ClientIdNumber>String</d2p1:ClientIdNumber>
      <d2p1:DocumentStatus>String</d2p1:DocumentStatus>
      <d2p1:GoalName>String</d2p1:GoalName>
      <d2p1:GoalTypeId>0</d2p1:GoalTypeId>
      <d2p1:InputCurrentSavings>0</d2p1:InputCurrentSavings>
      <d2p1:TotalRecords>0</d2p1:TotalRecords>
      <d2p1:UpdatedAsAt>0001-01-01T00:00:00</d2p1:UpdatedAsAt>
    </d2p1:ProposalView>
  </Result>
  <TotalPages>0</TotalPages>
  <TotalRecords>0</TotalRecords>
</GetProposalsResponse>