POST api/ApiIntegration/SBApiUpdateJob

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
PrivateApiKey		string	None.
JobInfo		ApiJobInfo	None.

Request Formats

application/json, text/json

Sample:

{
  "privateApiKey": "sample string 1",
  "jobInfo": {
    "jobKey": "506e8b10-5e96-4a71-998d-db58e16fa43c",
    "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",
    "quoteValue1": 1.0
  }
}

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>
    <JobKey>506e8b10-5e96-4a71-998d-db58e16fa43c</JobKey>
    <JobName>sample string 2</JobName>
    <JobNote1>sample string 5</JobNote1>
    <JobNote2>sample string 6</JobNote2>
    <JobNumber>sample string 8</JobNumber>
    <QuoteNumber>sample string 7</QuoteNumber>
    <QuoteValue1>1</QuoteValue1>
    <ScenarioName>sample string 3</ScenarioName>
  </JobInfo>
  <PrivateApiKey>sample string 1</PrivateApiKey>
</ApiUpdateJobInfo>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ApiResponse

Name	Type	Additional information
ResponseCode	integer	None.
ReturnKey	globally unique identifier	None.
ResponseNote	string	None.

Response Formats

application/json, text/json

Sample:

{
  "responseCode": 1,
  "returnKey": "dbeb71d5-6fa7-4cb8-892a-fbb7e815dd11",
  "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>dbeb71d5-6fa7-4cb8-892a-fbb7e815dd11</ReturnKey>
</ApiResponse>