| All Verbs | /proposals |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| SearchText | query | string | No | |
| FilterStatus | query | string | No | |
| PageNr | query | int | No | |
| PageSize | query | int | No | |
| PartnerId | query | int | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Result | form | List<ProposalView> | No | |
| TotalRecords | form | int | No | |
| TotalPages | form | int | No | |
| CurrentPageNr | form | int | No | |
| CurrentPage | form | int | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| 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 .csv suffix or ?format=csv
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/csv
Content-Type: text/csv
Content-Length: length
{"searchText":"String","filterStatus":"String","pageNr":0,"pageSize":0,"partnerId":0}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{"result":[{"updatedAsAt":"0001-01-01T00:00:00.0000000","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}