POST api/ApiIntegration/SBApiAddJobsToProject
Request Information
URI Parameters
None.
Body Parameters
ApiAddJobsToProject| Name | Description | 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": "d508ddc7-808f-4d11-b345-60ce0b636c1e",
"projectName": "sample string 2",
"jobName": "sample string 3",
"jobNote1": "sample string 4",
"jobNote2": "sample string 5",
"salesPerson": "sample string 6",
"jobDate": "2026-08-03T22:25:40.565072+00:00",
"quoteNumber": "sample string 7",
"jobNumber": "sample string 8",
"po": "sample string 9"
},
"jobsInfo": [
{
"jobKey": "6dd93736-6e42-4973-8b08-a9130ac96544",
"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:25:40.565072+00:00",
"purchaseOrder": "sample string 9",
"quoteValue1": 1.0,
"site": {
"measureDate": "2026-08-03T22:25:40.565072+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": "6dd93736-6e42-4973-8b08-a9130ac96544",
"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:25:40.565072+00:00",
"purchaseOrder": "sample string 9",
"quoteValue1": 1.0,
"site": {
"measureDate": "2026-08-03T22:25:40.565072+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:
<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>
<JobDate>2026-08-03T22:25:40.565072+00:00</JobDate>
<JobKey>6dd93736-6e42-4973-8b08-a9130ac96544</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:25:40.565072+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:25:40.565072+00:00</JobDate>
<JobKey>6dd93736-6e42-4973-8b08-a9130ac96544</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:25:40.565072+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>
<PrivateApiKey>sample string 1</PrivateApiKey>
<Project>
<JobDate>2026-08-03T22:25:40.565072+00:00</JobDate>
<JobName>sample string 3</JobName>
<JobNote1>sample string 4</JobNote1>
<JobNote2>sample string 5</JobNote2>
<JobNumber>sample string 8</JobNumber>
<PO>sample string 9</PO>
<ProjectKey>d508ddc7-808f-4d11-b345-60ce0b636c1e</ProjectKey>
<ProjectName>sample string 2</ProjectName>
<QuoteNumber>sample string 7</QuoteNumber>
<SalesPerson>sample string 6</SalesPerson>
</Project>
</ApiAddJobsToProject>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
ApiResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| ResponseCode | integer |
None. |
|
| ReturnKey | globally unique identifier |
None. |
|
| ResponseNote | string |
None. |
Response Formats
application/json, text/json
Sample:
{
"responseCode": 1,
"returnKey": "bcaf7f76-928d-4e40-a988-3526fc28322b",
"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>bcaf7f76-928d-4e40-a988-3526fc28322b</ReturnKey> </ApiResponse>