POST api/ApiIntegration/SBGetPartForecast

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
PrivateApiKey	string	None.
DateType	string	None.
StartDate	date	None.
EndDate	date	None.
GroupBy	string	None.

Request Formats

application/json, text/json

Sample:

{
  "privateApiKey": "sample string 1",
  "dateType": "sample string 2",
  "startDate": "2026-08-03T21:41:43.0356044+00:00",
  "endDate": "2026-08-03T21:41:43.0356044+00:00",
  "groupBy": "sample string 5"
}

application/xml, text/xml

Sample:

<ApiForecastParam xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/StairBiz.Contracts.ViewModels">
  <DateType>sample string 2</DateType>
  <EndDate>2026-08-03T21:41:43.0356044+00:00</EndDate>
  <GroupBy>sample string 5</GroupBy>
  <PrivateApiKey>sample string 1</PrivateApiKey>
  <StartDate>2026-08-03T21:41:43.0356044+00:00</StartDate>
</ApiForecastParam>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ApiPartForecast

Name	Description	Type	Additional information
Parts		Collection of ApiPartJobForecastInfo	None.
Jobs		Collection of ApiJobPartForecastInfo	None.

Response Formats

application/json, text/json

Sample:

{
  "parts": [
    {
      "partCode": "sample string 1",
      "partDescription": "sample string 2",
      "totalQuantity": 3,
      "earliestConfirmationDate": "sample string 4",
      "earliestInstallDate": "sample string 5",
      "jobs": [
        {
          "quantity": 1,
          "jobKey": "65613cb2-27f2-4457-92bb-93c1eac23451",
          "jobNumber": "sample string 3",
          "confirmationDate": "sample string 4",
          "installDate": "sample string 5"
        },
        {
          "quantity": 1,
          "jobKey": "65613cb2-27f2-4457-92bb-93c1eac23451",
          "jobNumber": "sample string 3",
          "confirmationDate": "sample string 4",
          "installDate": "sample string 5"
        }
      ]
    },
    {
      "partCode": "sample string 1",
      "partDescription": "sample string 2",
      "totalQuantity": 3,
      "earliestConfirmationDate": "sample string 4",
      "earliestInstallDate": "sample string 5",
      "jobs": [
        {
          "quantity": 1,
          "jobKey": "65613cb2-27f2-4457-92bb-93c1eac23451",
          "jobNumber": "sample string 3",
          "confirmationDate": "sample string 4",
          "installDate": "sample string 5"
        },
        {
          "quantity": 1,
          "jobKey": "65613cb2-27f2-4457-92bb-93c1eac23451",
          "jobNumber": "sample string 3",
          "confirmationDate": "sample string 4",
          "installDate": "sample string 5"
        }
      ]
    }
  ],
  "jobs": [
    {
      "job": {
        "jobKey": "ab8dea94-53b7-4a8c-85f1-75efc22222c9",
        "jobNumber": "sample string 2",
        "confirmationDate": "sample string 3",
        "installDate": "sample string 4"
      },
      "parts": [
        {
          "partCode": "sample string 1",
          "partDescription": "sample string 2",
          "quantity": 3
        },
        {
          "partCode": "sample string 1",
          "partDescription": "sample string 2",
          "quantity": 3
        }
      ]
    },
    {
      "job": {
        "jobKey": "ab8dea94-53b7-4a8c-85f1-75efc22222c9",
        "jobNumber": "sample string 2",
        "confirmationDate": "sample string 3",
        "installDate": "sample string 4"
      },
      "parts": [
        {
          "partCode": "sample string 1",
          "partDescription": "sample string 2",
          "quantity": 3
        },
        {
          "partCode": "sample string 1",
          "partDescription": "sample string 2",
          "quantity": 3
        }
      ]
    }
  ]
}

application/xml, text/xml

Sample:

<ApiPartForecast xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/StairBiz.Contracts.ViewModels">
  <Jobs>
    <ApiJobPartForecastInfo>
      <Job>
        <ConfirmationDate>sample string 3</ConfirmationDate>
        <InstallDate>sample string 4</InstallDate>
        <JobKey>ab8dea94-53b7-4a8c-85f1-75efc22222c9</JobKey>
        <JobNumber>sample string 2</JobNumber>
      </Job>
      <Parts>
        <ApiJobPartInfo>
          <PartCode>sample string 1</PartCode>
          <PartDescription>sample string 2</PartDescription>
          <Quantity>3</Quantity>
        </ApiJobPartInfo>
        <ApiJobPartInfo>
          <PartCode>sample string 1</PartCode>
          <PartDescription>sample string 2</PartDescription>
          <Quantity>3</Quantity>
        </ApiJobPartInfo>
      </Parts>
    </ApiJobPartForecastInfo>
    <ApiJobPartForecastInfo>
      <Job>
        <ConfirmationDate>sample string 3</ConfirmationDate>
        <InstallDate>sample string 4</InstallDate>
        <JobKey>ab8dea94-53b7-4a8c-85f1-75efc22222c9</JobKey>
        <JobNumber>sample string 2</JobNumber>
      </Job>
      <Parts>
        <ApiJobPartInfo>
          <PartCode>sample string 1</PartCode>
          <PartDescription>sample string 2</PartDescription>
          <Quantity>3</Quantity>
        </ApiJobPartInfo>
        <ApiJobPartInfo>
          <PartCode>sample string 1</PartCode>
          <PartDescription>sample string 2</PartDescription>
          <Quantity>3</Quantity>
        </ApiJobPartInfo>
      </Parts>
    </ApiJobPartForecastInfo>
  </Jobs>
  <Parts>
    <ApiPartJobForecastInfo>
      <EarliestConfirmationDate>sample string 4</EarliestConfirmationDate>
      <EarliestInstallDate>sample string 5</EarliestInstallDate>
      <Jobs>
        <ApiGroupByMaterialInfo>
          <ConfirmationDate>sample string 4</ConfirmationDate>
          <InstallDate>sample string 5</InstallDate>
          <JobKey>65613cb2-27f2-4457-92bb-93c1eac23451</JobKey>
          <JobNumber>sample string 3</JobNumber>
          <Quantity>1</Quantity>
        </ApiGroupByMaterialInfo>
        <ApiGroupByMaterialInfo>
          <ConfirmationDate>sample string 4</ConfirmationDate>
          <InstallDate>sample string 5</InstallDate>
          <JobKey>65613cb2-27f2-4457-92bb-93c1eac23451</JobKey>
          <JobNumber>sample string 3</JobNumber>
          <Quantity>1</Quantity>
        </ApiGroupByMaterialInfo>
      </Jobs>
      <PartCode>sample string 1</PartCode>
      <PartDescription>sample string 2</PartDescription>
      <TotalQuantity>3</TotalQuantity>
    </ApiPartJobForecastInfo>
    <ApiPartJobForecastInfo>
      <EarliestConfirmationDate>sample string 4</EarliestConfirmationDate>
      <EarliestInstallDate>sample string 5</EarliestInstallDate>
      <Jobs>
        <ApiGroupByMaterialInfo>
          <ConfirmationDate>sample string 4</ConfirmationDate>
          <InstallDate>sample string 5</InstallDate>
          <JobKey>65613cb2-27f2-4457-92bb-93c1eac23451</JobKey>
          <JobNumber>sample string 3</JobNumber>
          <Quantity>1</Quantity>
        </ApiGroupByMaterialInfo>
        <ApiGroupByMaterialInfo>
          <ConfirmationDate>sample string 4</ConfirmationDate>
          <InstallDate>sample string 5</InstallDate>
          <JobKey>65613cb2-27f2-4457-92bb-93c1eac23451</JobKey>
          <JobNumber>sample string 3</JobNumber>
          <Quantity>1</Quantity>
        </ApiGroupByMaterialInfo>
      </Jobs>
      <PartCode>sample string 1</PartCode>
      <PartDescription>sample string 2</PartDescription>
      <TotalQuantity>3</TotalQuantity>
    </ApiPartJobForecastInfo>
  </Parts>
</ApiPartForecast>