POST api/ApiIntegration/SBGetMaterialForecast

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:42.2225474+00:00",
  "endDate": "2026-08-03T21:41:42.2225474+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:42.2225474+00:00</EndDate>
  <GroupBy>sample string 5</GroupBy>
  <PrivateApiKey>sample string 1</PrivateApiKey>
  <StartDate>2026-08-03T21:41:42.2225474+00:00</StartDate>
</ApiForecastParam>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ApiMaterialForecast

Name	Description	Type	Additional information
Materials		Collection of ApiMaterialJobForecastInfo	None.
Jobs		Collection of ApiJobMaterialForecastInfo	None.

Response Formats

application/json, text/json

Sample:

{
  "materials": [
    {
      "material": "sample string 1",
      "totalQuantityRequired": 2,
      "costMethod": "sample string 3",
      "earliestConfirmationDate": "sample string 4",
      "earliestInstallDate": "sample string 5",
      "jobs": [
        {
          "quantity": 1,
          "jobKey": "0db3c1af-ba37-4e96-836d-f202bbbc8998",
          "jobNumber": "sample string 3",
          "confirmationDate": "sample string 4",
          "installDate": "sample string 5"
        },
        {
          "quantity": 1,
          "jobKey": "0db3c1af-ba37-4e96-836d-f202bbbc8998",
          "jobNumber": "sample string 3",
          "confirmationDate": "sample string 4",
          "installDate": "sample string 5"
        }
      ]
    },
    {
      "material": "sample string 1",
      "totalQuantityRequired": 2,
      "costMethod": "sample string 3",
      "earliestConfirmationDate": "sample string 4",
      "earliestInstallDate": "sample string 5",
      "jobs": [
        {
          "quantity": 1,
          "jobKey": "0db3c1af-ba37-4e96-836d-f202bbbc8998",
          "jobNumber": "sample string 3",
          "confirmationDate": "sample string 4",
          "installDate": "sample string 5"
        },
        {
          "quantity": 1,
          "jobKey": "0db3c1af-ba37-4e96-836d-f202bbbc8998",
          "jobNumber": "sample string 3",
          "confirmationDate": "sample string 4",
          "installDate": "sample string 5"
        }
      ]
    }
  ],
  "jobs": [
    {
      "job": {
        "jobKey": "68c49539-2f63-4031-8e93-eb7818175b78",
        "jobNumber": "sample string 2",
        "confirmationDate": "sample string 3",
        "installDate": "sample string 4"
      },
      "materials": [
        {
          "material": "sample string 1",
          "costMethod": "sample string 2",
          "quantity": 3
        },
        {
          "material": "sample string 1",
          "costMethod": "sample string 2",
          "quantity": 3
        }
      ]
    },
    {
      "job": {
        "jobKey": "68c49539-2f63-4031-8e93-eb7818175b78",
        "jobNumber": "sample string 2",
        "confirmationDate": "sample string 3",
        "installDate": "sample string 4"
      },
      "materials": [
        {
          "material": "sample string 1",
          "costMethod": "sample string 2",
          "quantity": 3
        },
        {
          "material": "sample string 1",
          "costMethod": "sample string 2",
          "quantity": 3
        }
      ]
    }
  ]
}

application/xml, text/xml

Sample:

<ApiMaterialForecast xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/StairBiz.Contracts.ViewModels">
  <Jobs>
    <ApiJobMaterialForecastInfo>
      <Job>
        <ConfirmationDate>sample string 3</ConfirmationDate>
        <InstallDate>sample string 4</InstallDate>
        <JobKey>68c49539-2f63-4031-8e93-eb7818175b78</JobKey>
        <JobNumber>sample string 2</JobNumber>
      </Job>
      <Materials>
        <ApiJobMaterialInfo>
          <CostMethod>sample string 2</CostMethod>
          <Material>sample string 1</Material>
          <Quantity>3</Quantity>
        </ApiJobMaterialInfo>
        <ApiJobMaterialInfo>
          <CostMethod>sample string 2</CostMethod>
          <Material>sample string 1</Material>
          <Quantity>3</Quantity>
        </ApiJobMaterialInfo>
      </Materials>
    </ApiJobMaterialForecastInfo>
    <ApiJobMaterialForecastInfo>
      <Job>
        <ConfirmationDate>sample string 3</ConfirmationDate>
        <InstallDate>sample string 4</InstallDate>
        <JobKey>68c49539-2f63-4031-8e93-eb7818175b78</JobKey>
        <JobNumber>sample string 2</JobNumber>
      </Job>
      <Materials>
        <ApiJobMaterialInfo>
          <CostMethod>sample string 2</CostMethod>
          <Material>sample string 1</Material>
          <Quantity>3</Quantity>
        </ApiJobMaterialInfo>
        <ApiJobMaterialInfo>
          <CostMethod>sample string 2</CostMethod>
          <Material>sample string 1</Material>
          <Quantity>3</Quantity>
        </ApiJobMaterialInfo>
      </Materials>
    </ApiJobMaterialForecastInfo>
  </Jobs>
  <Materials>
    <ApiMaterialJobForecastInfo>
      <CostMethod>sample string 3</CostMethod>
      <EarliestConfirmationDate>sample string 4</EarliestConfirmationDate>
      <EarliestInstallDate>sample string 5</EarliestInstallDate>
      <Jobs>
        <ApiGroupByMaterialInfo>
          <ConfirmationDate>sample string 4</ConfirmationDate>
          <InstallDate>sample string 5</InstallDate>
          <JobKey>0db3c1af-ba37-4e96-836d-f202bbbc8998</JobKey>
          <JobNumber>sample string 3</JobNumber>
          <Quantity>1</Quantity>
        </ApiGroupByMaterialInfo>
        <ApiGroupByMaterialInfo>
          <ConfirmationDate>sample string 4</ConfirmationDate>
          <InstallDate>sample string 5</InstallDate>
          <JobKey>0db3c1af-ba37-4e96-836d-f202bbbc8998</JobKey>
          <JobNumber>sample string 3</JobNumber>
          <Quantity>1</Quantity>
        </ApiGroupByMaterialInfo>
      </Jobs>
      <Material>sample string 1</Material>
      <TotalQuantityRequired>2</TotalQuantityRequired>
    </ApiMaterialJobForecastInfo>
    <ApiMaterialJobForecastInfo>
      <CostMethod>sample string 3</CostMethod>
      <EarliestConfirmationDate>sample string 4</EarliestConfirmationDate>
      <EarliestInstallDate>sample string 5</EarliestInstallDate>
      <Jobs>
        <ApiGroupByMaterialInfo>
          <ConfirmationDate>sample string 4</ConfirmationDate>
          <InstallDate>sample string 5</InstallDate>
          <JobKey>0db3c1af-ba37-4e96-836d-f202bbbc8998</JobKey>
          <JobNumber>sample string 3</JobNumber>
          <Quantity>1</Quantity>
        </ApiGroupByMaterialInfo>
        <ApiGroupByMaterialInfo>
          <ConfirmationDate>sample string 4</ConfirmationDate>
          <InstallDate>sample string 5</InstallDate>
          <JobKey>0db3c1af-ba37-4e96-836d-f202bbbc8998</JobKey>
          <JobNumber>sample string 3</JobNumber>
          <Quantity>1</Quantity>
        </ApiGroupByMaterialInfo>
      </Jobs>
      <Material>sample string 1</Material>
      <TotalQuantityRequired>2</TotalQuantityRequired>
    </ApiMaterialJobForecastInfo>
  </Materials>
</ApiMaterialForecast>