POST api/ApiIntegration/GetProjectQuoteInfo

Request Information

URI Parameters

None.

Body Parameters

ApiGetProjectParam
NameDescriptionTypeAdditional information
PrivateApiKey

string

None.

Project

ApiProjectModel

None.

Request Formats

application/json, text/json

Sample:
{
  "privateApiKey": "sample string 1",
  "project": {
    "privateApiKey": "sample string 1",
    "projectKey": "e86d3dbe-b350-4a55-b223-2b765124c59a",
    "projectName": "sample string 3"
  }
}

application/xml, text/xml

Sample:
<ApiGetProjectParam xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/StairBiz.Contracts.ViewModels">
  <PrivateApiKey>sample string 1</PrivateApiKey>
  <Project>
    <PrivateApiKey>sample string 1</PrivateApiKey>
    <ProjectKey>e86d3dbe-b350-4a55-b223-2b765124c59a</ProjectKey>
    <ProjectName>sample string 3</ProjectName>
  </Project>
</ApiGetProjectParam>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ApiQuoteDetails
NameDescriptionTypeAdditional information
apiResponse

ApiResponse

None.

JobsInfo

Collection of ApiJobInfo

None.

Response Formats

application/json, text/json

Sample:
{
  "apiResponse": {
    "responseCode": 1,
    "returnKey": "b27016dc-a7f8-4983-a438-a6888621f96f",
    "responseNote": "sample string 2"
  },
  "jobsInfo": [
    {
      "jobKey": "ab928dc7-d138-488b-b3eb-b8e0f9898398",
      "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": "ab928dc7-d138-488b-b3eb-b8e0f9898398",
      "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:
<ApiQuoteDetails 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>ab928dc7-d138-488b-b3eb-b8e0f9898398</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>ab928dc7-d138-488b-b3eb-b8e0f9898398</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>
  <apiResponse>
    <ResponseCode>1</ResponseCode>
    <ResponseNote>sample string 2</ResponseNote>
    <ReturnKey>b27016dc-a7f8-4983-a438-a6888621f96f</ReturnKey>
  </apiResponse>
</ApiQuoteDetails>