POST api/ApiIntegration/GetProjectQuoteInfo
Request Information
URI Parameters
None.
Body Parameters
ApiGetProjectParam| Name | Description | Type | Additional information |
|---|---|---|---|
| PrivateApiKey | string |
None. |
|
| Project | ApiProjectModel |
None. |
Request Formats
application/json, text/json
Sample:
{
"privateApiKey": "sample string 1",
"project": {
"privateApiKey": "sample string 1",
"projectKey": "305078c8-e4de-4b76-8b62-498a058da2e0",
"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>305078c8-e4de-4b76-8b62-498a058da2e0</ProjectKey>
<ProjectName>sample string 3</ProjectName>
</Project>
</ApiGetProjectParam>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
ApiQuoteDetails| Name | Description | Type | Additional information |
|---|---|---|---|
| ApiResponse | ApiResponse |
None. |
|
| JobsInfo | Collection of ApiJobInfo |
None. |
|
| NumberOfOptions | integer |
None. |
|
| ActiveQuoteReferenceNumber | string |
None. |
|
| ActiveQuoteValue | decimal number |
None. |
|
| ActiveQuoteLink | string |
None. |
|
| ActiveQuoteStatus | string |
None. |
|
| PaymentScheduleDepositValue | decimal number |
None. |
|
| PaymentSchedulePriorValue | decimal number |
None. |
|
| PaymentScheduleFinalValue | decimal number |
None. |
|
| ScheduleDate | date |
None. |
|
| InstallationDate | date |
None. |
|
| BillOfMaterials | ApiBillOfMaterials |
None. |
Response Formats
application/json, text/json
Sample:
{
"apiResponse": {
"responseCode": 1,
"returnKey": "9f6f53b4-1acd-4d41-8575-3b1048d006df",
"responseNote": "sample string 2"
},
"jobsInfo": [
{
"jobKey": "04229861-452e-4c96-a65c-21875e6a24ab",
"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-03T22:26:08.2833644+00:00",
"purchaseOrder": "sample string 9",
"quoteValue1": 1.0,
"site": {
"measureDate": "2026-08-03T22:26:08.2833644+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"
}
},
{
"jobKey": "04229861-452e-4c96-a65c-21875e6a24ab",
"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-03T22:26:08.2833644+00:00",
"purchaseOrder": "sample string 9",
"quoteValue1": 1.0,
"site": {
"measureDate": "2026-08-03T22:26:08.2833644+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"
}
}
],
"numberOfOptions": 1,
"activeQuoteReferenceNumber": "sample string 2",
"activeQuoteValue": 1.0,
"activeQuoteLink": "sample string 3",
"activeQuoteStatus": "sample string 4",
"paymentScheduleDepositValue": 1.0,
"paymentSchedulePriorValue": 1.0,
"paymentScheduleFinalValue": 1.0,
"scheduleDate": "2026-08-03T22:26:08.2833644+00:00",
"installationDate": "2026-08-03T22:26:08.2833644+00:00",
"billOfMaterials": {
"riserType": "sample string 1",
"riserMaterial": "sample string 2",
"handrailWallRailType": "sample string 3",
"handrailWallRailMaterial": "sample string 4",
"balusterType": "sample string 5",
"balusterMaterial": "sample string 6",
"treadMaterial": "sample string 7",
"stringerType": "sample string 8",
"stringerMaterial": "sample string 9",
"newelType": "sample string 10",
"newelMaterial": "sample string 11"
}
}
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">
<ActiveQuoteLink>sample string 3</ActiveQuoteLink>
<ActiveQuoteReferenceNumber>sample string 2</ActiveQuoteReferenceNumber>
<ActiveQuoteStatus>sample string 4</ActiveQuoteStatus>
<ActiveQuoteValue>1</ActiveQuoteValue>
<ApiResponse>
<ResponseCode>1</ResponseCode>
<ResponseNote>sample string 2</ResponseNote>
<ReturnKey>9f6f53b4-1acd-4d41-8575-3b1048d006df</ReturnKey>
</ApiResponse>
<BillOfMaterials>
<BalusterMaterial>sample string 6</BalusterMaterial>
<BalusterType>sample string 5</BalusterType>
<HandrailWallRailMaterial>sample string 4</HandrailWallRailMaterial>
<HandrailWallRailType>sample string 3</HandrailWallRailType>
<NewelMaterial>sample string 11</NewelMaterial>
<NewelType>sample string 10</NewelType>
<RiserMaterial>sample string 2</RiserMaterial>
<RiserType>sample string 1</RiserType>
<StringerMaterial>sample string 9</StringerMaterial>
<StringerType>sample string 8</StringerType>
<TreadMaterial>sample string 7</TreadMaterial>
</BillOfMaterials>
<InstallationDate>2026-08-03T22:26:08.2833644+00:00</InstallationDate>
<JobsInfo>
<ApiJobInfo>
<Estimator>sample string 4</Estimator>
<JobDate>2026-08-03T22:26:08.2833644+00:00</JobDate>
<JobKey>04229861-452e-4c96-a65c-21875e6a24ab</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-03T22:26:08.2833644+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>
</ApiJobInfo>
<ApiJobInfo>
<Estimator>sample string 4</Estimator>
<JobDate>2026-08-03T22:26:08.2833644+00:00</JobDate>
<JobKey>04229861-452e-4c96-a65c-21875e6a24ab</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-03T22:26:08.2833644+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>
</ApiJobInfo>
</JobsInfo>
<NumberOfOptions>1</NumberOfOptions>
<PaymentScheduleDepositValue>1</PaymentScheduleDepositValue>
<PaymentScheduleFinalValue>1</PaymentScheduleFinalValue>
<PaymentSchedulePriorValue>1</PaymentSchedulePriorValue>
<ScheduleDate>2026-08-03T22:26:08.2833644+00:00</ScheduleDate>
</ApiQuoteDetails>