PATCH api/bfg/v1/holdings/{holdingID}/holding-entries/{holdingEntryID}

Updates an existing holding entry's valuation.

Request Information

URI Parameters

Name	Description	Type	Additional information
holdingID	The ID of the holding that contains the entry.	integer	Required
holdingEntryID	The ID of the specific holding entry to update.	integer	Required

Body Parameters

The update request containing the and the new .

UpdateHoldingEntryRequest

Name	Description	Type	Additional information
PersonID		integer	Required
CostValue		decimal number	Required

Request Formats

application/json, text/json

Sample:

{
  "PersonID": 1,
  "CostValue": 2.0
}

application/xml, text/xml

Sample:

<UpdateHoldingEntryRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TPP.B2B.Webservices2.Contracts2.BFG.Holding">
  <CostValue>2</CostValue>
  <PersonID>1</PersonID>
</UpdateHoldingEntryRequest>

Response Information

Resource Description

Returns <see cref="T:TPP.B2B.Webservices2.Contracts2.BFG.Holding.UpdateHoldingEntryResult" /> if the update is successful. Returns an error response if validation fails or an exception occurs.

UpdateHoldingEntryResult

Name	Type	Additional information
HoldingID	integer	None.
HoldingEntryID	integer	None.
Success	boolean	None.
Errors	Collection of string	None.

Response Formats

application/json, text/json

Sample:

{
  "HoldingID": 1,
  "HoldingEntryID": 2,
  "Success": true,
  "Errors": [
    "sample string 1",
    "sample string 2"
  ]
}

application/xml, text/xml

Sample:

<UpdateHoldingEntryResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TPP.B2B.Webservices2.Contracts2.BFG.Holding">
  <Errors xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Errors>
  <HoldingEntryID>2</HoldingEntryID>
  <HoldingID>1</HoldingID>
  <Success>true</Success>
</UpdateHoldingEntryResult>

Error Response Information

Resource Description

Returns <see cref="T:TPP.B2B.Webservices2.Contracts2.BFG.Holding.UpdateHoldingEntryResult" /> if the update is successful. Returns an error response if validation fails or an exception occurs.

string

Error Response Formats

application/json, text/json

Sample:

"sample string 1"

application/xml, text/xml

Sample:

<string xmlns="http://schemas.microsoft.com/2003/10/Serialization/">sample string 1</string>