POST api/custom/CustomPositionWorkbench/GetPositions

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
BookIds	Collection of integer	None.
ProductIds	Collection of integer	None.
DisplayUomId	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "BookIds": [
    1,
    2
  ],
  "ProductIds": [
    1,
    2
  ],
  "DisplayUomId": 1
}

text/html

Sample:

{"BookIds":[1,2],"ProductIds":[1,2],"DisplayUomId":1}

application/xml, text/xml

Sample:

<CustomPositionWorkbenchQueryModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Gravitate.WebAPI.Areas.Custom.Models">
  <BookIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </BookIds>
  <DisplayUomId>1</DisplayUomId>
  <ProductIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </ProductIds>
</CustomPositionWorkbenchQueryModel>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'CustomPositionWorkbenchQueryModel'.

Response Information

Resource Description

CustomPositionWorkbenchModel

Name	Description	Type	Additional information
Positions		Collection of PositionModel	None.
Totals		PositionModel	None.

Response Formats

application/json, text/json

Sample:

{
  "Positions": [
    {
      "PositionId": 1,
      "BookName": "sample string 2",
      "InternalCounterPartyName": "sample string 3",
      "ProductName": "sample string 4",
      "Quantity": 1.0,
      "CurrentFiscalYearStart": "2025-12-10T08:28:13.730938-06:00",
      "CurrentTotal": 1.0,
      "NextFiscalYearStart": "2025-12-10T08:28:13.730938-06:00",
      "FutureTotal": 1.0,
      "Details": [
        {
          "DateTime": "2025-12-10T08:28:13.730938-06:00",
          "Quantity": 1.0
        },
        {
          "DateTime": "2025-12-10T08:28:13.730938-06:00",
          "Quantity": 1.0
        }
      ]
    },
    {
      "PositionId": 1,
      "BookName": "sample string 2",
      "InternalCounterPartyName": "sample string 3",
      "ProductName": "sample string 4",
      "Quantity": 1.0,
      "CurrentFiscalYearStart": "2025-12-10T08:28:13.730938-06:00",
      "CurrentTotal": 1.0,
      "NextFiscalYearStart": "2025-12-10T08:28:13.730938-06:00",
      "FutureTotal": 1.0,
      "Details": [
        {
          "DateTime": "2025-12-10T08:28:13.730938-06:00",
          "Quantity": 1.0
        },
        {
          "DateTime": "2025-12-10T08:28:13.730938-06:00",
          "Quantity": 1.0
        }
      ]
    }
  ],
  "Totals": {
    "PositionId": 1,
    "BookName": "sample string 2",
    "InternalCounterPartyName": "sample string 3",
    "ProductName": "sample string 4",
    "Quantity": 1.0,
    "CurrentFiscalYearStart": "2025-12-10T08:28:13.730938-06:00",
    "CurrentTotal": 1.0,
    "NextFiscalYearStart": "2025-12-10T08:28:13.730938-06:00",
    "FutureTotal": 1.0,
    "Details": [
      {
        "DateTime": "2025-12-10T08:28:13.730938-06:00",
        "Quantity": 1.0
      },
      {
        "DateTime": "2025-12-10T08:28:13.730938-06:00",
        "Quantity": 1.0
      }
    ]
  }
}

text/html

Sample:

{"Positions":[{"PositionId":1,"BookName":"sample string 2","InternalCounterPartyName":"sample string 3","ProductName":"sample string 4","Quantity":1.0,"CurrentFiscalYearStart":"2025-12-10T08:28:13.730938-06:00","CurrentTotal":1.0,"NextFiscalYearStart":"2025-12-10T08:28:13.730938-06:00","FutureTotal":1.0,"Details":[{"DateTime":"2025-12-10T08:28:13.730938-06:00","Quantity":1.0},{"DateTime":"2025-12-10T08:28:13.730938-06:00","Quantity":1.0}]},{"PositionId":1,"BookName":"sample string 2","InternalCounterPartyName":"sample string 3","ProductName":"sample string 4","Quantity":1.0,"CurrentFiscalYearStart":"2025-12-10T08:28:13.730938-06:00","CurrentTotal":1.0,"NextFiscalYearStart":"2025-12-10T08:28:13.730938-06:00","FutureTotal":1.0,"Details":[{"DateTime":"2025-12-10T08:28:13.730938-06:00","Quantity":1.0},{"DateTime":"2025-12-10T08:28:13.730938-06:00","Quantity":1.0}]}],"Totals":{"PositionId":1,"BookName":"sample string 2","InternalCounterPartyName":"sample string 3","ProductName":"sample string 4","Quantity":1.0,"CurrentFiscalYearStart":"2025-12-10T08:28:13.730938-06:00","CurrentTotal":1.0,"NextFiscalYearStart":"2025-12-10T08:28:13.730938-06:00","FutureTotal":1.0,"Details":[{"DateTime":"2025-12-10T08:28:13.730938-06:00","Quantity":1.0},{"DateTime":"2025-12-10T08:28:13.730938-06:00","Quantity":1.0}]}}

application/xml, text/xml

Sample:

<CustomPositionWorkbenchModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Gravitate.WebAPI.Areas.Custom.Models">
  <Positions>
    <CustomPositionWorkbenchModel.PositionModel>
      <BookName>sample string 2</BookName>
      <CurrentFiscalYearStart>2025-12-10T08:28:13.730938-06:00</CurrentFiscalYearStart>
      <CurrentTotal>1</CurrentTotal>
      <Details>
        <CustomPositionWorkbenchModel.PositionDetailModel>
          <DateTime>2025-12-10T08:28:13.730938-06:00</DateTime>
          <Quantity>1</Quantity>
        </CustomPositionWorkbenchModel.PositionDetailModel>
        <CustomPositionWorkbenchModel.PositionDetailModel>
          <DateTime>2025-12-10T08:28:13.730938-06:00</DateTime>
          <Quantity>1</Quantity>
        </CustomPositionWorkbenchModel.PositionDetailModel>
      </Details>
      <FutureTotal>1</FutureTotal>
      <InternalCounterPartyName>sample string 3</InternalCounterPartyName>
      <NextFiscalYearStart>2025-12-10T08:28:13.730938-06:00</NextFiscalYearStart>
      <PositionId>1</PositionId>
      <ProductName>sample string 4</ProductName>
      <Quantity>1</Quantity>
    </CustomPositionWorkbenchModel.PositionModel>
    <CustomPositionWorkbenchModel.PositionModel>
      <BookName>sample string 2</BookName>
      <CurrentFiscalYearStart>2025-12-10T08:28:13.730938-06:00</CurrentFiscalYearStart>
      <CurrentTotal>1</CurrentTotal>
      <Details>
        <CustomPositionWorkbenchModel.PositionDetailModel>
          <DateTime>2025-12-10T08:28:13.730938-06:00</DateTime>
          <Quantity>1</Quantity>
        </CustomPositionWorkbenchModel.PositionDetailModel>
        <CustomPositionWorkbenchModel.PositionDetailModel>
          <DateTime>2025-12-10T08:28:13.730938-06:00</DateTime>
          <Quantity>1</Quantity>
        </CustomPositionWorkbenchModel.PositionDetailModel>
      </Details>
      <FutureTotal>1</FutureTotal>
      <InternalCounterPartyName>sample string 3</InternalCounterPartyName>
      <NextFiscalYearStart>2025-12-10T08:28:13.730938-06:00</NextFiscalYearStart>
      <PositionId>1</PositionId>
      <ProductName>sample string 4</ProductName>
      <Quantity>1</Quantity>
    </CustomPositionWorkbenchModel.PositionModel>
  </Positions>
  <Totals>
    <BookName>sample string 2</BookName>
    <CurrentFiscalYearStart>2025-12-10T08:28:13.730938-06:00</CurrentFiscalYearStart>
    <CurrentTotal>1</CurrentTotal>
    <Details>
      <CustomPositionWorkbenchModel.PositionDetailModel>
        <DateTime>2025-12-10T08:28:13.730938-06:00</DateTime>
        <Quantity>1</Quantity>
      </CustomPositionWorkbenchModel.PositionDetailModel>
      <CustomPositionWorkbenchModel.PositionDetailModel>
        <DateTime>2025-12-10T08:28:13.730938-06:00</DateTime>
        <Quantity>1</Quantity>
      </CustomPositionWorkbenchModel.PositionDetailModel>
    </Details>
    <FutureTotal>1</FutureTotal>
    <InternalCounterPartyName>sample string 3</InternalCounterPartyName>
    <NextFiscalYearStart>2025-12-10T08:28:13.730938-06:00</NextFiscalYearStart>
    <PositionId>1</PositionId>
    <ProductName>sample string 4</ProductName>
    <Quantity>1</Quantity>
  </Totals>
</CustomPositionWorkbenchModel>