GET api/bfg/v1/orders/unsettles?clientId={clientId}

Get list of outstanding fund obligations by person

Request Information

URI Parameters

Name	Description	Type	Additional information
clientId		integer	Required

Body Parameters

None.

Response Information

Resource Description

List of outstanding fund obligations

OutstandingFundObligationResult

Name	Type	Additional information
MinOutstandingClientObligationId	integer	None.
OutstandingFundObligation	Collection of OutstandingFundObligation	None.
Success	boolean	None.
Errors	Collection of string	None.

Response Formats

application/json, text/json

Sample:

{
  "MinOutstandingClientObligationId": 1,
  "OutstandingFundObligation": [
    {
      "SourceID": 1,
      "OwnerID": 2,
      "Amount": 3.0,
      "AmountFilled": 4.0,
      "AmountFunded": 5.0
    },
    {
      "SourceID": 1,
      "OwnerID": 2,
      "Amount": 3.0,
      "AmountFilled": 4.0,
      "AmountFunded": 5.0
    }
  ],
  "Success": true,
  "Errors": [
    "sample string 1",
    "sample string 2"
  ]
}

application/xml, text/xml

Sample:

<OutstandingFundObligationResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TPP.B2B.Webservices2.Contracts2.BFG.Order">
  <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>
  <MinOutstandingClientObligationId>1</MinOutstandingClientObligationId>
  <OutstandingFundObligation>
    <OutstandingFundObligation>
      <Amount>3</Amount>
      <AmountFilled>4</AmountFilled>
      <AmountFunded>5</AmountFunded>
      <OwnerID>2</OwnerID>
      <SourceID>1</SourceID>
    </OutstandingFundObligation>
    <OutstandingFundObligation>
      <Amount>3</Amount>
      <AmountFilled>4</AmountFilled>
      <AmountFunded>5</AmountFunded>
      <OwnerID>2</OwnerID>
      <SourceID>1</SourceID>
    </OutstandingFundObligation>
  </OutstandingFundObligation>
  <Success>true</Success>
</OutstandingFundObligationResult>