POST api/ApiIntegration/GetProjectQuoteInfo

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
PrivateApiKey		string	None.
Project		ApiProjectModel	None.

Request Formats

application/json, text/json

Sample:

{
  "privateApiKey": "sample string 1",
  "project": {
    "privateApiKey": "sample string 1",
    "projectKey": "a23372b6-9874-4841-b60b-cdfa9049aa43",
    "projectName": "sample string 3"
  }
}

application/xml, text/xml

Sample:

<ApiGetProjectParam xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/StairBiz.Contracts.ViewModels">
  <PrivateApiKey>sample string 1</PrivateApiKey>
  <Project>
    <PrivateApiKey>sample string 1</PrivateApiKey>
    <ProjectKey>a23372b6-9874-4841-b60b-cdfa9049aa43</ProjectKey>
    <ProjectName>sample string 3</ProjectName>
  </Project>
</ApiGetProjectParam>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ApiQuoteDetails

Name	Type	Additional information
ApiResponse	ApiResponse	None.
JobsInfo	Collection of ApiJobInfo	None.
NumberOfOptions	integer	None.
ActiveQuoteReferenceNumber	string	None.
ActiveQuoteValue	decimal number	None.
ActiveQuoteLink	string	None.
ActiveQuoteStatus	string	None.
PaymentScheduleDepositValue	decimal number	None.
PaymentSchedulePriorValue	decimal number	None.
PaymentScheduleFinalValue	decimal number	None.
ScheduleDate	date	None.
InstallationDate	date	None.
BillOfMaterials	ApiBillOfMaterials	None.

Response Formats

application/json, text/json

Sample:

{
  "apiResponse": {
    "responseCode": 1,
    "returnKey": "a1998462-e934-490e-8171-0532999104f2",
    "responseNote": "sample string 2"
  },
  "jobsInfo": [
    {
      "jobKey": "44a3cc81-5f4c-45ef-a3a5-b50a34cbf6ff",
      "jobName": "sample string 2",
      "scenarioName": "sample string 3",
      "estimator": "sample string 4",
      "jobNote1": "sample string 5",
      "jobNote2": "sample string 6",
      "quoteNumber": "sample string 7",
      "jobNumber": "sample string 8",
      "jobDate": "2026-06-19T19:15:56.5140961+00:00",
      "purchaseOrder": "sample string 9",
      "quoteValue1": 1.0
    },
    {
      "jobKey": "44a3cc81-5f4c-45ef-a3a5-b50a34cbf6ff",
      "jobName": "sample string 2",
      "scenarioName": "sample string 3",
      "estimator": "sample string 4",
      "jobNote1": "sample string 5",
      "jobNote2": "sample string 6",
      "quoteNumber": "sample string 7",
      "jobNumber": "sample string 8",
      "jobDate": "2026-06-19T19:15:56.5140961+00:00",
      "purchaseOrder": "sample string 9",
      "quoteValue1": 1.0
    }
  ],
  "numberOfOptions": 1,
  "activeQuoteReferenceNumber": "sample string 2",
  "activeQuoteValue": 1.0,
  "activeQuoteLink": "sample string 3",
  "activeQuoteStatus": "sample string 4",
  "paymentScheduleDepositValue": 1.0,
  "paymentSchedulePriorValue": 1.0,
  "paymentScheduleFinalValue": 1.0,
  "scheduleDate": "2026-06-19T19:15:56.5140961+00:00",
  "installationDate": "2026-06-19T19:15:56.5140961+00:00",
  "billOfMaterials": {
    "riserType": "sample string 1",
    "riserMaterial": "sample string 2",
    "handrailWallRailType": "sample string 3",
    "handrailWallRailMaterial": "sample string 4",
    "balusterType": "sample string 5",
    "balusterMaterial": "sample string 6",
    "treadMaterial": "sample string 7",
    "stringerType": "sample string 8",
    "stringerMaterial": "sample string 9",
    "newelType": "sample string 10",
    "newelMaterial": "sample string 11"
  }
}

application/xml, text/xml

Sample:

<ApiQuoteDetails xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/StairBiz.Contracts.ViewModels">
  <ActiveQuoteLink>sample string 3</ActiveQuoteLink>
  <ActiveQuoteReferenceNumber>sample string 2</ActiveQuoteReferenceNumber>
  <ActiveQuoteStatus>sample string 4</ActiveQuoteStatus>
  <ActiveQuoteValue>1</ActiveQuoteValue>
  <ApiResponse>
    <ResponseCode>1</ResponseCode>
    <ResponseNote>sample string 2</ResponseNote>
    <ReturnKey>a1998462-e934-490e-8171-0532999104f2</ReturnKey>
  </ApiResponse>
  <BillOfMaterials>
    <BalusterMaterial>sample string 6</BalusterMaterial>
    <BalusterType>sample string 5</BalusterType>
    <HandrailWallRailMaterial>sample string 4</HandrailWallRailMaterial>
    <HandrailWallRailType>sample string 3</HandrailWallRailType>
    <NewelMaterial>sample string 11</NewelMaterial>
    <NewelType>sample string 10</NewelType>
    <RiserMaterial>sample string 2</RiserMaterial>
    <RiserType>sample string 1</RiserType>
    <StringerMaterial>sample string 9</StringerMaterial>
    <StringerType>sample string 8</StringerType>
    <TreadMaterial>sample string 7</TreadMaterial>
  </BillOfMaterials>
  <InstallationDate>2026-06-19T19:15:56.5140961+00:00</InstallationDate>
  <JobsInfo>
    <ApiJobInfo>
      <Estimator>sample string 4</Estimator>
      <JobDate>2026-06-19T19:15:56.5140961+00:00</JobDate>
      <JobKey>44a3cc81-5f4c-45ef-a3a5-b50a34cbf6ff</JobKey>
      <JobName>sample string 2</JobName>
      <JobNote1>sample string 5</JobNote1>
      <JobNote2>sample string 6</JobNote2>
      <JobNumber>sample string 8</JobNumber>
      <PurchaseOrder>sample string 9</PurchaseOrder>
      <QuoteNumber>sample string 7</QuoteNumber>
      <QuoteValue1>1</QuoteValue1>
      <ScenarioName>sample string 3</ScenarioName>
    </ApiJobInfo>
    <ApiJobInfo>
      <Estimator>sample string 4</Estimator>
      <JobDate>2026-06-19T19:15:56.5140961+00:00</JobDate>
      <JobKey>44a3cc81-5f4c-45ef-a3a5-b50a34cbf6ff</JobKey>
      <JobName>sample string 2</JobName>
      <JobNote1>sample string 5</JobNote1>
      <JobNote2>sample string 6</JobNote2>
      <JobNumber>sample string 8</JobNumber>
      <PurchaseOrder>sample string 9</PurchaseOrder>
      <QuoteNumber>sample string 7</QuoteNumber>
      <QuoteValue1>1</QuoteValue1>
      <ScenarioName>sample string 3</ScenarioName>
    </ApiJobInfo>
  </JobsInfo>
  <NumberOfOptions>1</NumberOfOptions>
  <PaymentScheduleDepositValue>1</PaymentScheduleDepositValue>
  <PaymentScheduleFinalValue>1</PaymentScheduleFinalValue>
  <PaymentSchedulePriorValue>1</PaymentSchedulePriorValue>
  <ScheduleDate>2026-06-19T19:15:56.5140961+00:00</ScheduleDate>
</ApiQuoteDetails>