POST api/ApiIntegration/SBApiAddJobsToProject

Request Information

URI Parameters

None.

Body Parameters

ApiAddJobsToProject
NameDescriptionTypeAdditional information
PrivateApiKey

string

None.

Project

ApiProjectInfo

None.

JobsInfo

Collection of ApiJobInfo

None.

Request Formats

application/json, text/json

Sample:
{
  "privateApiKey": "sample string 1",
  "project": {
    "projectKey": "4f67d574-0a7d-469e-8c1b-93c05d8f9b7e",
    "projectName": "sample string 2",
    "jobName": "sample string 3",
    "jobNote1": "sample string 4",
    "jobNote2": "sample string 5",
    "salesPerson": "sample string 6",
    "jobDate": "2026-06-19T19:14:15.0488508+00:00",
    "quoteNumber": "sample string 7",
    "jobNumber": "sample string 8",
    "po": "sample string 9"
  },
  "jobsInfo": [
    {
      "jobKey": "d699b58b-f320-46b1-a33e-ec65c444fde8",
      "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:14:15.0488508+00:00",
      "purchaseOrder": "sample string 9",
      "quoteValue1": 1.0
    },
    {
      "jobKey": "d699b58b-f320-46b1-a33e-ec65c444fde8",
      "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:14:15.0488508+00:00",
      "purchaseOrder": "sample string 9",
      "quoteValue1": 1.0
    }
  ]
}

application/xml, text/xml

Sample:
<ApiAddJobsToProject xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/StairBiz.Contracts.ViewModels">
  <JobsInfo>
    <ApiJobInfo>
      <Estimator>sample string 4</Estimator>
      <JobDate>2026-06-19T19:14:15.0488508+00:00</JobDate>
      <JobKey>d699b58b-f320-46b1-a33e-ec65c444fde8</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:14:15.0488508+00:00</JobDate>
      <JobKey>d699b58b-f320-46b1-a33e-ec65c444fde8</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>
  <PrivateApiKey>sample string 1</PrivateApiKey>
  <Project>
    <JobDate>2026-06-19T19:14:15.0488508+00:00</JobDate>
    <JobName>sample string 3</JobName>
    <JobNote1>sample string 4</JobNote1>
    <JobNote2>sample string 5</JobNote2>
    <JobNumber>sample string 8</JobNumber>
    <PO>sample string 9</PO>
    <ProjectKey>4f67d574-0a7d-469e-8c1b-93c05d8f9b7e</ProjectKey>
    <ProjectName>sample string 2</ProjectName>
    <QuoteNumber>sample string 7</QuoteNumber>
    <SalesPerson>sample string 6</SalesPerson>
  </Project>
</ApiAddJobsToProject>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ApiResponse
NameDescriptionTypeAdditional information
ResponseCode

integer

None.

ReturnKey

globally unique identifier

None.

ResponseNote

string

None.

Response Formats

application/json, text/json

Sample:
{
  "responseCode": 1,
  "returnKey": "602caffd-7811-4461-82b2-cf7bf4f40033",
  "responseNote": "sample string 2"
}

application/xml, text/xml

Sample:
<ApiResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/StairBiz.Contracts.ViewModels">
  <ResponseCode>1</ResponseCode>
  <ResponseNote>sample string 2</ResponseNote>
  <ReturnKey>602caffd-7811-4461-82b2-cf7bf4f40033</ReturnKey>
</ApiResponse>