POST api/ApiIntegration/SBApiGetAllProjects
Request Information
URI Parameters
None.
Body Parameters
ApiGetProjectsParam| Name | Description | Type | Additional information |
|---|---|---|---|
| PrivateApiKey | string |
None. |
|
| StartDate | date |
None. |
|
| EndDate | date |
None. |
Request Formats
application/json, text/json
Sample:
{
"privateApiKey": "sample string 1",
"startDate": "2026-11-03T19:31:06.932874+00:00",
"endDate": "2026-11-03T19:31:06.932874+00:00"
}
application/xml, text/xml
Sample:
<ApiGetProjectsParam xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/StairBiz.Contracts.ViewModels"> <EndDate>2026-11-03T19:31:06.932874+00:00</EndDate> <PrivateApiKey>sample string 1</PrivateApiKey> <StartDate>2026-11-03T19:31:06.932874+00:00</StartDate> </ApiGetProjectsParam>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
ApiProjectListResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| ApiResponse | ApiResponse |
None. |
|
| Projects | Collection of ApiProjectListItem |
None. |
Response Formats
application/json, text/json
Sample:
{
"apiResponse": {
"responseCode": 1,
"returnKey": "35f63928-3693-43b5-9530-f12a8e2a1ba4",
"responseNote": "sample string 2",
"errorString": "sample string 3"
},
"projects": [
{
"projectKey": "19b2582d-9297-4de3-891d-f80686551118",
"projectName": "sample string 2",
"jobCount": 3,
"jobs": [
{
"jobKey": "4e678bb2-065d-4595-9fa7-facfb28b1b27",
"jobName": "sample string 2",
"jobNumber": "sample string 3",
"quoteNumber": "sample string 4",
"createdDate": "2026-11-03T19:31:06.9641264+00:00",
"updatedDate": "2026-11-03T19:31:06.9641264+00:00",
"activeScenario": true,
"scenarios": [
{
"scenarioKey": "769c5357-e22d-4bfc-9257-eead9282fea6",
"scenarioName": "sample string 2",
"jobName": "sample string 3",
"createdDate": "2026-11-03T19:31:06.9641264+00:00",
"updatedDate": "2026-11-03T19:31:06.9641264+00:00"
},
{
"scenarioKey": "769c5357-e22d-4bfc-9257-eead9282fea6",
"scenarioName": "sample string 2",
"jobName": "sample string 3",
"createdDate": "2026-11-03T19:31:06.9641264+00:00",
"updatedDate": "2026-11-03T19:31:06.9641264+00:00"
}
]
},
{
"jobKey": "4e678bb2-065d-4595-9fa7-facfb28b1b27",
"jobName": "sample string 2",
"jobNumber": "sample string 3",
"quoteNumber": "sample string 4",
"createdDate": "2026-11-03T19:31:06.9641264+00:00",
"updatedDate": "2026-11-03T19:31:06.9641264+00:00",
"activeScenario": true,
"scenarios": [
{
"scenarioKey": "769c5357-e22d-4bfc-9257-eead9282fea6",
"scenarioName": "sample string 2",
"jobName": "sample string 3",
"createdDate": "2026-11-03T19:31:06.9641264+00:00",
"updatedDate": "2026-11-03T19:31:06.9641264+00:00"
},
{
"scenarioKey": "769c5357-e22d-4bfc-9257-eead9282fea6",
"scenarioName": "sample string 2",
"jobName": "sample string 3",
"createdDate": "2026-11-03T19:31:06.9641264+00:00",
"updatedDate": "2026-11-03T19:31:06.9641264+00:00"
}
]
}
]
},
{
"projectKey": "19b2582d-9297-4de3-891d-f80686551118",
"projectName": "sample string 2",
"jobCount": 3,
"jobs": [
{
"jobKey": "4e678bb2-065d-4595-9fa7-facfb28b1b27",
"jobName": "sample string 2",
"jobNumber": "sample string 3",
"quoteNumber": "sample string 4",
"createdDate": "2026-11-03T19:31:06.9641264+00:00",
"updatedDate": "2026-11-03T19:31:06.9641264+00:00",
"activeScenario": true,
"scenarios": [
{
"scenarioKey": "769c5357-e22d-4bfc-9257-eead9282fea6",
"scenarioName": "sample string 2",
"jobName": "sample string 3",
"createdDate": "2026-11-03T19:31:06.9641264+00:00",
"updatedDate": "2026-11-03T19:31:06.9641264+00:00"
},
{
"scenarioKey": "769c5357-e22d-4bfc-9257-eead9282fea6",
"scenarioName": "sample string 2",
"jobName": "sample string 3",
"createdDate": "2026-11-03T19:31:06.9641264+00:00",
"updatedDate": "2026-11-03T19:31:06.9641264+00:00"
}
]
},
{
"jobKey": "4e678bb2-065d-4595-9fa7-facfb28b1b27",
"jobName": "sample string 2",
"jobNumber": "sample string 3",
"quoteNumber": "sample string 4",
"createdDate": "2026-11-03T19:31:06.9641264+00:00",
"updatedDate": "2026-11-03T19:31:06.9641264+00:00",
"activeScenario": true,
"scenarios": [
{
"scenarioKey": "769c5357-e22d-4bfc-9257-eead9282fea6",
"scenarioName": "sample string 2",
"jobName": "sample string 3",
"createdDate": "2026-11-03T19:31:06.9641264+00:00",
"updatedDate": "2026-11-03T19:31:06.9641264+00:00"
},
{
"scenarioKey": "769c5357-e22d-4bfc-9257-eead9282fea6",
"scenarioName": "sample string 2",
"jobName": "sample string 3",
"createdDate": "2026-11-03T19:31:06.9641264+00:00",
"updatedDate": "2026-11-03T19:31:06.9641264+00:00"
}
]
}
]
}
]
}
application/xml, text/xml
Sample:
<ApiProjectListResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/StairBiz.Contracts.ViewModels">
<ApiResponse>
<ErrorString>sample string 3</ErrorString>
<ResponseCode>1</ResponseCode>
<ResponseNote>sample string 2</ResponseNote>
<ReturnKey>35f63928-3693-43b5-9530-f12a8e2a1ba4</ReturnKey>
</ApiResponse>
<Projects>
<ApiProjectListItem>
<JobCount>3</JobCount>
<Jobs>
<ApiJobListItem>
<ActiveScenario>true</ActiveScenario>
<CreatedDate>2026-11-03T19:31:06.9641264+00:00</CreatedDate>
<JobKey>4e678bb2-065d-4595-9fa7-facfb28b1b27</JobKey>
<JobName>sample string 2</JobName>
<JobNumber>sample string 3</JobNumber>
<QuoteNumber>sample string 4</QuoteNumber>
<Scenarios>
<ApiScenarioListItem>
<CreatedDate>2026-11-03T19:31:06.9641264+00:00</CreatedDate>
<JobName>sample string 3</JobName>
<ScenarioKey>769c5357-e22d-4bfc-9257-eead9282fea6</ScenarioKey>
<ScenarioName>sample string 2</ScenarioName>
<UpdatedDate>2026-11-03T19:31:06.9641264+00:00</UpdatedDate>
</ApiScenarioListItem>
<ApiScenarioListItem>
<CreatedDate>2026-11-03T19:31:06.9641264+00:00</CreatedDate>
<JobName>sample string 3</JobName>
<ScenarioKey>769c5357-e22d-4bfc-9257-eead9282fea6</ScenarioKey>
<ScenarioName>sample string 2</ScenarioName>
<UpdatedDate>2026-11-03T19:31:06.9641264+00:00</UpdatedDate>
</ApiScenarioListItem>
</Scenarios>
<UpdatedDate>2026-11-03T19:31:06.9641264+00:00</UpdatedDate>
</ApiJobListItem>
<ApiJobListItem>
<ActiveScenario>true</ActiveScenario>
<CreatedDate>2026-11-03T19:31:06.9641264+00:00</CreatedDate>
<JobKey>4e678bb2-065d-4595-9fa7-facfb28b1b27</JobKey>
<JobName>sample string 2</JobName>
<JobNumber>sample string 3</JobNumber>
<QuoteNumber>sample string 4</QuoteNumber>
<Scenarios>
<ApiScenarioListItem>
<CreatedDate>2026-11-03T19:31:06.9641264+00:00</CreatedDate>
<JobName>sample string 3</JobName>
<ScenarioKey>769c5357-e22d-4bfc-9257-eead9282fea6</ScenarioKey>
<ScenarioName>sample string 2</ScenarioName>
<UpdatedDate>2026-11-03T19:31:06.9641264+00:00</UpdatedDate>
</ApiScenarioListItem>
<ApiScenarioListItem>
<CreatedDate>2026-11-03T19:31:06.9641264+00:00</CreatedDate>
<JobName>sample string 3</JobName>
<ScenarioKey>769c5357-e22d-4bfc-9257-eead9282fea6</ScenarioKey>
<ScenarioName>sample string 2</ScenarioName>
<UpdatedDate>2026-11-03T19:31:06.9641264+00:00</UpdatedDate>
</ApiScenarioListItem>
</Scenarios>
<UpdatedDate>2026-11-03T19:31:06.9641264+00:00</UpdatedDate>
</ApiJobListItem>
</Jobs>
<ProjectKey>19b2582d-9297-4de3-891d-f80686551118</ProjectKey>
<ProjectName>sample string 2</ProjectName>
</ApiProjectListItem>
<ApiProjectListItem>
<JobCount>3</JobCount>
<Jobs>
<ApiJobListItem>
<ActiveScenario>true</ActiveScenario>
<CreatedDate>2026-11-03T19:31:06.9641264+00:00</CreatedDate>
<JobKey>4e678bb2-065d-4595-9fa7-facfb28b1b27</JobKey>
<JobName>sample string 2</JobName>
<JobNumber>sample string 3</JobNumber>
<QuoteNumber>sample string 4</QuoteNumber>
<Scenarios>
<ApiScenarioListItem>
<CreatedDate>2026-11-03T19:31:06.9641264+00:00</CreatedDate>
<JobName>sample string 3</JobName>
<ScenarioKey>769c5357-e22d-4bfc-9257-eead9282fea6</ScenarioKey>
<ScenarioName>sample string 2</ScenarioName>
<UpdatedDate>2026-11-03T19:31:06.9641264+00:00</UpdatedDate>
</ApiScenarioListItem>
<ApiScenarioListItem>
<CreatedDate>2026-11-03T19:31:06.9641264+00:00</CreatedDate>
<JobName>sample string 3</JobName>
<ScenarioKey>769c5357-e22d-4bfc-9257-eead9282fea6</ScenarioKey>
<ScenarioName>sample string 2</ScenarioName>
<UpdatedDate>2026-11-03T19:31:06.9641264+00:00</UpdatedDate>
</ApiScenarioListItem>
</Scenarios>
<UpdatedDate>2026-11-03T19:31:06.9641264+00:00</UpdatedDate>
</ApiJobListItem>
<ApiJobListItem>
<ActiveScenario>true</ActiveScenario>
<CreatedDate>2026-11-03T19:31:06.9641264+00:00</CreatedDate>
<JobKey>4e678bb2-065d-4595-9fa7-facfb28b1b27</JobKey>
<JobName>sample string 2</JobName>
<JobNumber>sample string 3</JobNumber>
<QuoteNumber>sample string 4</QuoteNumber>
<Scenarios>
<ApiScenarioListItem>
<CreatedDate>2026-11-03T19:31:06.9641264+00:00</CreatedDate>
<JobName>sample string 3</JobName>
<ScenarioKey>769c5357-e22d-4bfc-9257-eead9282fea6</ScenarioKey>
<ScenarioName>sample string 2</ScenarioName>
<UpdatedDate>2026-11-03T19:31:06.9641264+00:00</UpdatedDate>
</ApiScenarioListItem>
<ApiScenarioListItem>
<CreatedDate>2026-11-03T19:31:06.9641264+00:00</CreatedDate>
<JobName>sample string 3</JobName>
<ScenarioKey>769c5357-e22d-4bfc-9257-eead9282fea6</ScenarioKey>
<ScenarioName>sample string 2</ScenarioName>
<UpdatedDate>2026-11-03T19:31:06.9641264+00:00</UpdatedDate>
</ApiScenarioListItem>
</Scenarios>
<UpdatedDate>2026-11-03T19:31:06.9641264+00:00</UpdatedDate>
</ApiJobListItem>
</Jobs>
<ProjectKey>19b2582d-9297-4de3-891d-f80686551118</ProjectKey>
<ProjectName>sample string 2</ProjectName>
</ApiProjectListItem>
</Projects>
</ApiProjectListResponse>