POST api/ApiIntegration/SBApiGetJobSavedData

Request Information

URI Parameters

None.

Body Parameters

ApiGetJobSavedDataParam
NameDescriptionTypeAdditional information
PrivateApiKey

string

None.

QuoteNumber

string

None.

Request Formats

application/json, text/json

Sample:
{
  "privateApiKey": "sample string 1",
  "quoteNumber": "sample string 2"
}

application/xml, text/xml

Sample:
<ApiGetJobSavedDataParam xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/StairBiz.Contracts.ViewModels">
  <PrivateApiKey>sample string 1</PrivateApiKey>
  <QuoteNumber>sample string 2</QuoteNumber>
</ApiGetJobSavedDataParam>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ApiJobSavedDataResponse
NameDescriptionTypeAdditional information
JobData

PipeDriveWrapper

None.

ResponseCode

integer

None.

ReturnKey

globally unique identifier

None.

ResponseNote

string

None.

ErrorString

string

None.

Response Formats

application/json, text/json

Sample:
{
  "jobData": {
    "eventType": "sample string 1",
    "eventTimeStamp": "2026-11-03T16:31:36.2294374+00:00",
    "project": {
      "projectKey": "829e80cc-3571-4fe5-98a3-f1c054c8a6bf",
      "projectName": "sample string 2",
      "totalProject": 3,
      "clientKey": "6ae1fd19-2f4d-4135-a1fd-6f4d2f668151"
    },
    "client": {
      "clientKey": "3dc5bc15-a1c8-45de-9cd9-5cc6841ba7ad",
      "clientName": "sample string 1",
      "contactName": "sample string 2",
      "street": "sample string 3",
      "suburb": "sample string 4",
      "city": "sample string 5",
      "state": "sample string 6",
      "zip": "sample string 7",
      "phone": "sample string 8",
      "email": "sample string 9"
    },
    "site": {
      "siteContact": "sample string 1",
      "street": "sample string 2",
      "suburb": "sample string 3",
      "city": "sample string 4",
      "state": "sample string 5",
      "zip": "sample string 6",
      "siteEmail": "sample string 7",
      "phone": "sample string 8"
    },
    "job": {
      "jobKey": "a2f6ed45-2d73-4c6c-be6b-14f92e5d028d",
      "jobName": "sample string 2",
      "jobStatusId": 3,
      "jobStatus": "sample string 4",
      "jobNumber": "sample string 5",
      "salesPerson": "sample string 6"
    },
    "processWindow": {
      "scenarioName": "sample string 1",
      "quoteNumber": "sample string 2",
      "jobStatus": "sample string 3",
      "activeScenario": true
    },
    "quoteWindow": {
      "grandTotal": 1.0,
      "dueAmt1": 2.0,
      "dueAmt2": 3.0,
      "dueAmt3": 4.0,
      "quoteLink": "sample string 5"
    },
    "material": {
      "totalNumberOfProjectScenarios": 1,
      "typeOfProject": "sample string 2",
      "riserType": "sample string 3",
      "riserMaterial": "sample string 4",
      "handrailType": "sample string 5",
      "handrailMaterial": "sample string 6",
      "wallRailType": "sample string 7",
      "wallRailMaterial": "sample string 8",
      "balusterType": "sample string 9",
      "balusterMaterial": "sample string 10",
      "treadMaterial": "sample string 11",
      "stringerType": "sample string 12",
      "stringerMaterial": "sample string 13",
      "newelType": "sample string 14",
      "newelMaterial": "sample string 15"
    }
  },
  "responseCode": 1,
  "returnKey": "d6f00d87-7d87-402e-af31-479b6116ea9f",
  "responseNote": "sample string 2",
  "errorString": "sample string 3"
}

application/xml, text/xml

Sample:
<ApiJobSavedDataResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/StairBiz.Contracts.ViewModels">
  <ErrorString>sample string 3</ErrorString>
  <ResponseCode>1</ResponseCode>
  <ResponseNote>sample string 2</ResponseNote>
  <ReturnKey>d6f00d87-7d87-402e-af31-479b6116ea9f</ReturnKey>
  <JobData>
    <Client>
      <City>sample string 5</City>
      <ClientKey>3dc5bc15-a1c8-45de-9cd9-5cc6841ba7ad</ClientKey>
      <ClientName>sample string 1</ClientName>
      <ContactName>sample string 2</ContactName>
      <Email>sample string 9</Email>
      <Phone>sample string 8</Phone>
      <State>sample string 6</State>
      <Street>sample string 3</Street>
      <Suburb>sample string 4</Suburb>
      <Zip>sample string 7</Zip>
    </Client>
    <EventTimeStamp>2026-11-03T16:31:36.2294374+00:00</EventTimeStamp>
    <EventType>sample string 1</EventType>
    <Job>
      <JobKey>a2f6ed45-2d73-4c6c-be6b-14f92e5d028d</JobKey>
      <JobName>sample string 2</JobName>
      <JobNumber>sample string 5</JobNumber>
      <JobStatusId>3</JobStatusId>
      <SalesPerson>sample string 6</SalesPerson>
      <jobStatus>sample string 4</jobStatus>
    </Job>
    <Material>
      <BalusterMaterial>sample string 10</BalusterMaterial>
      <BalusterType>sample string 9</BalusterType>
      <HandrailMaterial>sample string 6</HandrailMaterial>
      <HandrailType>sample string 5</HandrailType>
      <NewelMaterial>sample string 15</NewelMaterial>
      <NewelType>sample string 14</NewelType>
      <RiserMaterial>sample string 4</RiserMaterial>
      <RiserType>sample string 3</RiserType>
      <StringerMaterial>sample string 13</StringerMaterial>
      <StringerType>sample string 12</StringerType>
      <TotalNumberOfProjectScenarios>1</TotalNumberOfProjectScenarios>
      <TreadMaterial>sample string 11</TreadMaterial>
      <TypeOfProject>sample string 2</TypeOfProject>
      <WallRailMaterial>sample string 8</WallRailMaterial>
      <WallRailType>sample string 7</WallRailType>
    </Material>
    <ProcessWindow>
      <ActiveScenario>true</ActiveScenario>
      <JobStatus>sample string 3</JobStatus>
      <QuoteNumber>sample string 2</QuoteNumber>
      <ScenarioName>sample string 1</ScenarioName>
    </ProcessWindow>
    <Project>
      <ClientKey>6ae1fd19-2f4d-4135-a1fd-6f4d2f668151</ClientKey>
      <ProjectKey>829e80cc-3571-4fe5-98a3-f1c054c8a6bf</ProjectKey>
      <ProjectName>sample string 2</ProjectName>
      <TotalProject>3</TotalProject>
    </Project>
    <QuoteWindow>
      <DueAmt1>2</DueAmt1>
      <DueAmt2>3</DueAmt2>
      <DueAmt3>4</DueAmt3>
      <GrandTotal>1</GrandTotal>
      <QuoteLink>sample string 5</QuoteLink>
    </QuoteWindow>
    <Site>
      <City>sample string 4</City>
      <Phone>sample string 8</Phone>
      <SiteContact>sample string 1</SiteContact>
      <SiteEmail>sample string 7</SiteEmail>
      <State>sample string 5</State>
      <Street>sample string 2</Street>
      <Suburb>sample string 3</Suburb>
      <Zip>sample string 6</Zip>
    </Site>
  </JobData>
</ApiJobSavedDataResponse>