POST api/ApiIntegration/SBApiGetJobQuoteData

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
PrivateApiKey	string	None.
ProjectKey	globally unique identifier	None.
ScenarioKey	globally unique identifier	None.

Request Formats

application/json, text/json

Sample:

{
  "privateApiKey": "sample string 1",
  "projectKey": "d6d00ba9-5f32-47d9-9113-4f6f86e55d0d",
  "scenarioKey": "b530a163-b548-4eea-80eb-4585db1edcc3"
}

application/xml, text/xml

Sample:

<ApiGetJobQuoteDataParam xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/StairBiz.Contracts.ViewModels">
  <PrivateApiKey>sample string 1</PrivateApiKey>
  <ProjectKey>d6d00ba9-5f32-47d9-9113-4f6f86e55d0d</ProjectKey>
  <ScenarioKey>b530a163-b548-4eea-80eb-4585db1edcc3</ScenarioKey>
</ApiGetJobQuoteDataParam>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ApiJobQuoteDataResponse

Name	Type	Additional information
ProjectKey	globally unique identifier	None.
ProjectName	string	None.
Scenarios	Collection of ApiJobQuoteScenario	None.
ResponseCode	integer	None.
ReturnKey	globally unique identifier	None.
ResponseNote	string	None.
ErrorString	string	None.

Response Formats

application/json, text/json

Sample:

{
  "projectKey": "bca3351c-40e8-4a2f-975b-2b37d0423e78",
  "projectName": "sample string 1",
  "scenarios": [
    {
      "jobKey": "02f51991-95d3-496d-8e62-c8788bab3655",
      "scenarioKey": "efb6166e-c3b6-488c-85a3-b7ee29d8ebbe",
      "modelName": "sample string 2",
      "scenarioName": "sample string 3",
      "isRailing": true,
      "jobNumber": "sample string 5",
      "quoteNumber": "sample string 6",
      "pricingBasis": "sample string 7",
      "materialCost": 8.0,
      "materialBreakdown": {
        "parts": 1.0,
        "lineItems": 2.0,
        "timber": 3.0
      },
      "laborCost": 9.0,
      "laborBreakdown": {
        "build": 1.0,
        "deliver": 2.0,
        "install": 3.0
      },
      "overheadCost": 10.0,
      "truckCost": 11.0,
      "netCost": 12.0,
      "markupPercent": 13.0,
      "netProfit": 14.0,
      "profitAdjust": 15.0,
      "discount": 16.0,
      "preTaxTotal": 17.0,
      "tax1": 18.0,
      "tax2": 19.0,
      "quoteTotal": 20.0,
      "duePercent1": 21.0,
      "duePercent2": 22.0,
      "finalPercent": 23.0,
      "frozen": true,
      "version": "2026-11-03T16:23:09.9063486+00:00",
      "lineItemsBasis": "sample string 25",
      "hasLineItems": true,
      "productLines": {},
      "lineItemsSavedAt": "2026-11-03T16:23:09.9063486+00:00",
      "stairSkus": [
        {
          "productCode": "sample string 1",
          "stairNo": "sample string 2",
          "skus": [
            "sample string 1",
            "sample string 2"
          ]
        },
        {
          "productCode": "sample string 1",
          "stairNo": "sample string 2",
          "skus": [
            "sample string 1",
            "sample string 2"
          ]
        }
      ],
      "productCodesSavedAt": "2026-11-03T16:23:09.9063486+00:00",
      "costBasisTrustworthy": true,
      "warnings": [
        "sample string 1",
        "sample string 2"
      ]
    },
    {
      "jobKey": "02f51991-95d3-496d-8e62-c8788bab3655",
      "scenarioKey": "efb6166e-c3b6-488c-85a3-b7ee29d8ebbe",
      "modelName": "sample string 2",
      "scenarioName": "sample string 3",
      "isRailing": true,
      "jobNumber": "sample string 5",
      "quoteNumber": "sample string 6",
      "pricingBasis": "sample string 7",
      "materialCost": 8.0,
      "materialBreakdown": {
        "parts": 1.0,
        "lineItems": 2.0,
        "timber": 3.0
      },
      "laborCost": 9.0,
      "laborBreakdown": {
        "build": 1.0,
        "deliver": 2.0,
        "install": 3.0
      },
      "overheadCost": 10.0,
      "truckCost": 11.0,
      "netCost": 12.0,
      "markupPercent": 13.0,
      "netProfit": 14.0,
      "profitAdjust": 15.0,
      "discount": 16.0,
      "preTaxTotal": 17.0,
      "tax1": 18.0,
      "tax2": 19.0,
      "quoteTotal": 20.0,
      "duePercent1": 21.0,
      "duePercent2": 22.0,
      "finalPercent": 23.0,
      "frozen": true,
      "version": "2026-11-03T16:23:09.9063486+00:00",
      "lineItemsBasis": "sample string 25",
      "hasLineItems": true,
      "productLines": {},
      "lineItemsSavedAt": "2026-11-03T16:23:09.9063486+00:00",
      "stairSkus": [
        {
          "productCode": "sample string 1",
          "stairNo": "sample string 2",
          "skus": [
            "sample string 1",
            "sample string 2"
          ]
        },
        {
          "productCode": "sample string 1",
          "stairNo": "sample string 2",
          "skus": [
            "sample string 1",
            "sample string 2"
          ]
        }
      ],
      "productCodesSavedAt": "2026-11-03T16:23:09.9063486+00:00",
      "costBasisTrustworthy": true,
      "warnings": [
        "sample string 1",
        "sample string 2"
      ]
    }
  ],
  "responseCode": 2,
  "returnKey": "845c70ff-55cf-40ae-9177-853fd5f1cf01",
  "responseNote": "sample string 3",
  "errorString": "sample string 4"
}

application/xml, text/xml

Sample:

<ApiJobQuoteDataResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/StairBiz.Contracts.ViewModels">
  <ErrorString>sample string 4</ErrorString>
  <ResponseCode>2</ResponseCode>
  <ResponseNote>sample string 3</ResponseNote>
  <ReturnKey>845c70ff-55cf-40ae-9177-853fd5f1cf01</ReturnKey>
  <ProjectKey>bca3351c-40e8-4a2f-975b-2b37d0423e78</ProjectKey>
  <ProjectName>sample string 1</ProjectName>
  <Scenarios>
    <ApiJobQuoteScenario>
      <CostBasisTrustworthy>true</CostBasisTrustworthy>
      <Discount>16</Discount>
      <DuePercent1>21</DuePercent1>
      <DuePercent2>22</DuePercent2>
      <FinalPercent>23</FinalPercent>
      <Frozen>true</Frozen>
      <HasLineItems>true</HasLineItems>
      <IsRailing>true</IsRailing>
      <JobNumber>sample string 5</JobNumber>
      <LaborBreakdown>
        <Build>1</Build>
        <Deliver>2</Deliver>
        <Install>3</Install>
      </LaborBreakdown>
      <LaborCost>9</LaborCost>
      <LineItemsBasis>sample string 25</LineItemsBasis>
      <LineItemsSavedAt xmlns:d4p1="http://schemas.datacontract.org/2004/07/System">
        <d4p1:DateTime>2026-11-03T16:23:09.9063486Z</d4p1:DateTime>
        <d4p1:OffsetMinutes>0</d4p1:OffsetMinutes>
      </LineItemsSavedAt>
      <MarkupPercent>13</MarkupPercent>
      <MaterialBreakdown>
        <LineItems>2</LineItems>
        <Parts>1</Parts>
        <Timber>3</Timber>
      </MaterialBreakdown>
      <MaterialCost>8</MaterialCost>
      <ModelKey>02f51991-95d3-496d-8e62-c8788bab3655</ModelKey>
      <ModelName>sample string 2</ModelName>
      <NetCost>12</NetCost>
      <NetProfit>14</NetProfit>
      <OverheadCost>10</OverheadCost>
      <PreTaxTotal>17</PreTaxTotal>
      <PricingBasis>sample string 7</PricingBasis>
      <ProductCodesSavedAt xmlns:d4p1="http://schemas.datacontract.org/2004/07/System">
        <d4p1:DateTime>2026-11-03T16:23:09.9063486Z</d4p1:DateTime>
        <d4p1:OffsetMinutes>0</d4p1:OffsetMinutes>
      </ProductCodesSavedAt>
      <ProductLines />
      <ProfitAdjust>15</ProfitAdjust>
      <QuoteNumber>sample string 6</QuoteNumber>
      <QuoteTotal>20</QuoteTotal>
      <ScenarioKey>efb6166e-c3b6-488c-85a3-b7ee29d8ebbe</ScenarioKey>
      <ScenarioName>sample string 3</ScenarioName>
      <StairSkus>
        <ApiStairSkuInfo>
          <ProductCode>sample string 1</ProductCode>
          <Skus xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:string>sample string 1</d6p1:string>
            <d6p1:string>sample string 2</d6p1:string>
          </Skus>
          <StairNo>sample string 2</StairNo>
        </ApiStairSkuInfo>
        <ApiStairSkuInfo>
          <ProductCode>sample string 1</ProductCode>
          <Skus xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:string>sample string 1</d6p1:string>
            <d6p1:string>sample string 2</d6p1:string>
          </Skus>
          <StairNo>sample string 2</StairNo>
        </ApiStairSkuInfo>
      </StairSkus>
      <Tax1>18</Tax1>
      <Tax2>19</Tax2>
      <TruckCost>11</TruckCost>
      <Version xmlns:d4p1="http://schemas.datacontract.org/2004/07/System">
        <d4p1:DateTime>2026-11-03T16:23:09.9063486Z</d4p1:DateTime>
        <d4p1:OffsetMinutes>0</d4p1:OffsetMinutes>
      </Version>
      <Warnings xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </Warnings>
    </ApiJobQuoteScenario>
    <ApiJobQuoteScenario>
      <CostBasisTrustworthy>true</CostBasisTrustworthy>
      <Discount>16</Discount>
      <DuePercent1>21</DuePercent1>
      <DuePercent2>22</DuePercent2>
      <FinalPercent>23</FinalPercent>
      <Frozen>true</Frozen>
      <HasLineItems>true</HasLineItems>
      <IsRailing>true</IsRailing>
      <JobNumber>sample string 5</JobNumber>
      <LaborBreakdown>
        <Build>1</Build>
        <Deliver>2</Deliver>
        <Install>3</Install>
      </LaborBreakdown>
      <LaborCost>9</LaborCost>
      <LineItemsBasis>sample string 25</LineItemsBasis>
      <LineItemsSavedAt xmlns:d4p1="http://schemas.datacontract.org/2004/07/System">
        <d4p1:DateTime>2026-11-03T16:23:09.9063486Z</d4p1:DateTime>
        <d4p1:OffsetMinutes>0</d4p1:OffsetMinutes>
      </LineItemsSavedAt>
      <MarkupPercent>13</MarkupPercent>
      <MaterialBreakdown>
        <LineItems>2</LineItems>
        <Parts>1</Parts>
        <Timber>3</Timber>
      </MaterialBreakdown>
      <MaterialCost>8</MaterialCost>
      <ModelKey>02f51991-95d3-496d-8e62-c8788bab3655</ModelKey>
      <ModelName>sample string 2</ModelName>
      <NetCost>12</NetCost>
      <NetProfit>14</NetProfit>
      <OverheadCost>10</OverheadCost>
      <PreTaxTotal>17</PreTaxTotal>
      <PricingBasis>sample string 7</PricingBasis>
      <ProductCodesSavedAt xmlns:d4p1="http://schemas.datacontract.org/2004/07/System">
        <d4p1:DateTime>2026-11-03T16:23:09.9063486Z</d4p1:DateTime>
        <d4p1:OffsetMinutes>0</d4p1:OffsetMinutes>
      </ProductCodesSavedAt>
      <ProductLines />
      <ProfitAdjust>15</ProfitAdjust>
      <QuoteNumber>sample string 6</QuoteNumber>
      <QuoteTotal>20</QuoteTotal>
      <ScenarioKey>efb6166e-c3b6-488c-85a3-b7ee29d8ebbe</ScenarioKey>
      <ScenarioName>sample string 3</ScenarioName>
      <StairSkus>
        <ApiStairSkuInfo>
          <ProductCode>sample string 1</ProductCode>
          <Skus xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:string>sample string 1</d6p1:string>
            <d6p1:string>sample string 2</d6p1:string>
          </Skus>
          <StairNo>sample string 2</StairNo>
        </ApiStairSkuInfo>
        <ApiStairSkuInfo>
          <ProductCode>sample string 1</ProductCode>
          <Skus xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:string>sample string 1</d6p1:string>
            <d6p1:string>sample string 2</d6p1:string>
          </Skus>
          <StairNo>sample string 2</StairNo>
        </ApiStairSkuInfo>
      </StairSkus>
      <Tax1>18</Tax1>
      <Tax2>19</Tax2>
      <TruckCost>11</TruckCost>
      <Version xmlns:d4p1="http://schemas.datacontract.org/2004/07/System">
        <d4p1:DateTime>2026-11-03T16:23:09.9063486Z</d4p1:DateTime>
        <d4p1:OffsetMinutes>0</d4p1:OffsetMinutes>
      </Version>
      <Warnings xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </Warnings>
    </ApiJobQuoteScenario>
  </Scenarios>
</ApiJobQuoteDataResponse>