POST api/ApiIntegration/SBApiAddJobsToProject

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional 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": "db597f0e-6d2b-403f-b349-bc5940ab8ffd",
    "projectName": "sample string 2"
  },
  "jobsInfo": [
    {
      "jobKey": "3476728a-7213-484e-a01a-8cdb037615e1",
      "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
    },
    {
      "jobKey": "3476728a-7213-484e-a01a-8cdb037615e1",
      "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:

<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>
      <JobKey>3476728a-7213-484e-a01a-8cdb037615e1</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>
    </ApiJobInfo>
    <ApiJobInfo>
      <Estimator>sample string 4</Estimator>
      <JobKey>3476728a-7213-484e-a01a-8cdb037615e1</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>
    </ApiJobInfo>
  </JobsInfo>
  <PrivateApiKey>sample string 1</PrivateApiKey>
  <Project>
    <ProjectKey>db597f0e-6d2b-403f-b349-bc5940ab8ffd</ProjectKey>
    <ProjectName>sample string 2</ProjectName>
  </Project>
</ApiAddJobsToProject>

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": "f46faf5b-1d52-4aec-aeda-74f1817b3aec",
  "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>f46faf5b-1d52-4aec-aeda-74f1817b3aec</ReturnKey>
</ApiResponse>