| All Verbs | /animation/video |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | query | int | No | |
| Guid | query | string | No | |
| UniqueId | query | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Result | form | ProposalV2SummaryAdobe | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ProposalId | form | string | No | |
| ProposalName | form | string | No | |
| ProposalDescription | form | string | No | |
| CustomCoverLetterText | form | string | No | |
| PartnerId | form | int | No | |
| Partner | form | string | No | |
| PartnerLogo | form | string | No | |
| VideoLogo | form | string | No | |
| PrimaryColour | form | string | No | |
| SecondaryColour | form | string | No | |
| SecondaryColourOpacity | form | double | No | |
| FirstName | form | string | No | |
| FullName | form | string | No | |
| ClientId | form | int | No | |
| Goals | form | List<ClientGoalSummary> | No | |
| CreatedAsAt | form | DateTime | No | |
| UpdatedAsAt | form | DateTime | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| GoalType | form | string | No | |
| GoalName | form | string | No | |
| GoalDescription | form | string | No | |
| GoalPictureUrl | form | string | No | |
| GoalCurrency | form | string | No | |
| PortfolioName | form | string | No | |
| GoalOutcomeDescription | form | string | No | |
| FundName | form | string | No | |
| ProjectedBalances | form | List<AdobeRangeSeries> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Type | form | string | No | |
| Label | form | string | No | |
| Items | form | List<AdobeSeriesItem> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Year | form | int | No | |
| Value | form | decimal? | No | |
| RangeValue1Field | form | decimal? | No | |
| RangeValue2Field | form | decimal? | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /animation/video HTTP/1.1
Host: api.portfoliolink.co.za
Accept: application/json
Content-Type: application/json
Content-Length: length
{"id":0,"guid":"String","uniqueId":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"result":{"proposalId":"String","proposalName":"String","proposalDescription":"String","customCoverLetterText":"String","partnerId":0,"partner":"String","partnerLogo":"String","videoLogo":"String","primaryColour":"String","secondaryColour":"String","secondaryColourOpacity":0,"firstName":"String","fullName":"String","clientId":0,"goals":[{"goalType":"String","goalName":"String","goalDescription":"String","goalPictureUrl":"String","goalCurrency":"String","portfolioName":"String","goalOutcomeDescription":"String","fundName":"String","projectedBalances":[{"type":"String","label":"String","items":[{"year":0,"value":0,"rangeValue1Field":0,"rangeValue2Field":0}]}]}],"createdAsAt":"0001-01-01T00:00:00.0000000","updatedAsAt":"0001-01-01T00:00:00.0000000"}}