POST api/ApiIntegration/SBApiUpdateJob

Request Information

URI Parameters

None.

Body Parameters

ApiUpdateJobInfo
NameDescriptionTypeAdditional information
PrivateApiKey

string

None.

JobInfo

ApiJobInfo

None.

Request Formats

application/json, text/json

Sample:
{
  "privateApiKey": "sample string 1",
  "jobInfo": {
    "jobKey": "2e2528b4-29d2-4ef7-afaa-f2ec975bd583",
    "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-08-03T21:43:37.9711523+00:00",
    "purchaseOrder": "sample string 9",
    "quoteValue1": 1.0,
    "site": {
      "measureDate": "2026-08-03T21:43:37.9711523+00:00",
      "siteContact": "sample string 1",
      "street": "sample string 2",
      "suburb": "sample string 3",
      "city": "sample string 4",
      "state": "sample string 5",
      "crossStreet": "sample string 6",
      "phone": "sample string 7",
      "newHome": true,
      "siteNoteOne": "sample string 9",
      "mobile": "sample string 10",
      "siteNoteTwo": "sample string 11",
      "zip": "sample string 12",
      "measureTime": "00:00:00.1234567",
      "siteEmail": "sample string 13"
    }
  }
}

application/xml, text/xml

Sample:
<ApiUpdateJobInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/StairBiz.Contracts.ViewModels">
  <JobInfo>
    <Estimator>sample string 4</Estimator>
    <JobDate>2026-08-03T21:43:37.9711523+00:00</JobDate>
    <JobKey>2e2528b4-29d2-4ef7-afaa-f2ec975bd583</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>
    <Site>
      <City>sample string 4</City>
      <CrossStreet>sample string 6</CrossStreet>
      <MeasureDate>2026-08-03T21:43:37.9711523+00:00</MeasureDate>
      <MeasureTime>PT0.1234567S</MeasureTime>
      <Mobile>sample string 10</Mobile>
      <NewHome>true</NewHome>
      <Phone>sample string 7</Phone>
      <SiteContact>sample string 1</SiteContact>
      <SiteEmail>sample string 13</SiteEmail>
      <SiteNoteOne>sample string 9</SiteNoteOne>
      <SiteNoteTwo>sample string 11</SiteNoteTwo>
      <State>sample string 5</State>
      <Street>sample string 2</Street>
      <Suburb>sample string 3</Suburb>
      <Zip>sample string 12</Zip>
    </Site>
  </JobInfo>
  <PrivateApiKey>sample string 1</PrivateApiKey>
</ApiUpdateJobInfo>

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": "0707e4b6-5f7a-44d8-a5aa-5375994203d9",
  "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>0707e4b6-5f7a-44d8-a5aa-5375994203d9</ReturnKey>
</ApiResponse>