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-08-03T22:26:57.9053303+00:00",
"endDate": "2026-08-03T22:26:57.9053303+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-08-03T22:26:57.9053303+00:00</EndDate> <PrivateApiKey>sample string 1</PrivateApiKey> <StartDate>2026-08-03T22:26:57.9053303+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": "04000ce2-e339-42ea-94be-c351511eccdf",
"responseNote": "sample string 2"
},
"projects": [
{
"projectKey": "2314a9fd-1028-4f0c-bdff-b3ef53df2f14",
"projectName": "sample string 2",
"jobCount": 3,
"jobs": [
{
"jobKey": "f5c61855-0830-4df2-99f3-e09a11bfd025",
"jobName": "sample string 2",
"jobNumber": "sample string 3",
"quoteNumber": "sample string 4",
"createdDate": "2026-08-03T22:26:57.9251327+00:00",
"updatedDate": "2026-08-03T22:26:57.9251327+00:00",
"activeScenario": true,
"scenarios": [
{
"scenarioKey": "c02e76fa-cfff-467f-80d5-b77901122d54",
"scenarioName": "sample string 2",
"jobName": "sample string 3",
"createdDate": "2026-08-03T22:26:57.9251327+00:00",
"updatedDate": "2026-08-03T22:26:57.9251327+00:00"
},
{
"scenarioKey": "c02e76fa-cfff-467f-80d5-b77901122d54",
"scenarioName": "sample string 2",
"jobName": "sample string 3",
"createdDate": "2026-08-03T22:26:57.9251327+00:00",
"updatedDate": "2026-08-03T22:26:57.9251327+00:00"
}
]
},
{
"jobKey": "f5c61855-0830-4df2-99f3-e09a11bfd025",
"jobName": "sample string 2",
"jobNumber": "sample string 3",
"quoteNumber": "sample string 4",
"createdDate": "2026-08-03T22:26:57.9251327+00:00",
"updatedDate": "2026-08-03T22:26:57.9251327+00:00",
"activeScenario": true,
"scenarios": [
{
"scenarioKey": "c02e76fa-cfff-467f-80d5-b77901122d54",
"scenarioName": "sample string 2",
"jobName": "sample string 3",
"createdDate": "2026-08-03T22:26:57.9251327+00:00",
"updatedDate": "2026-08-03T22:26:57.9251327+00:00"
},
{
"scenarioKey": "c02e76fa-cfff-467f-80d5-b77901122d54",
"scenarioName": "sample string 2",
"jobName": "sample string 3",
"createdDate": "2026-08-03T22:26:57.9251327+00:00",
"updatedDate": "2026-08-03T22:26:57.9251327+00:00"
}
]
}
]
},
{
"projectKey": "2314a9fd-1028-4f0c-bdff-b3ef53df2f14",
"projectName": "sample string 2",
"jobCount": 3,
"jobs": [
{
"jobKey": "f5c61855-0830-4df2-99f3-e09a11bfd025",
"jobName": "sample string 2",
"jobNumber": "sample string 3",
"quoteNumber": "sample string 4",
"createdDate": "2026-08-03T22:26:57.9251327+00:00",
"updatedDate": "2026-08-03T22:26:57.9251327+00:00",
"activeScenario": true,
"scenarios": [
{
"scenarioKey": "c02e76fa-cfff-467f-80d5-b77901122d54",
"scenarioName": "sample string 2",
"jobName": "sample string 3",
"createdDate": "2026-08-03T22:26:57.9251327+00:00",
"updatedDate": "2026-08-03T22:26:57.9251327+00:00"
},
{
"scenarioKey": "c02e76fa-cfff-467f-80d5-b77901122d54",
"scenarioName": "sample string 2",
"jobName": "sample string 3",
"createdDate": "2026-08-03T22:26:57.9251327+00:00",
"updatedDate": "2026-08-03T22:26:57.9251327+00:00"
}
]
},
{
"jobKey": "f5c61855-0830-4df2-99f3-e09a11bfd025",
"jobName": "sample string 2",
"jobNumber": "sample string 3",
"quoteNumber": "sample string 4",
"createdDate": "2026-08-03T22:26:57.9251327+00:00",
"updatedDate": "2026-08-03T22:26:57.9251327+00:00",
"activeScenario": true,
"scenarios": [
{
"scenarioKey": "c02e76fa-cfff-467f-80d5-b77901122d54",
"scenarioName": "sample string 2",
"jobName": "sample string 3",
"createdDate": "2026-08-03T22:26:57.9251327+00:00",
"updatedDate": "2026-08-03T22:26:57.9251327+00:00"
},
{
"scenarioKey": "c02e76fa-cfff-467f-80d5-b77901122d54",
"scenarioName": "sample string 2",
"jobName": "sample string 3",
"createdDate": "2026-08-03T22:26:57.9251327+00:00",
"updatedDate": "2026-08-03T22:26:57.9251327+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>
<ResponseCode>1</ResponseCode>
<ResponseNote>sample string 2</ResponseNote>
<ReturnKey>04000ce2-e339-42ea-94be-c351511eccdf</ReturnKey>
</ApiResponse>
<Projects>
<ApiProjectListItem>
<JobCount>3</JobCount>
<Jobs>
<ApiJobListItem>
<ActiveScenario>true</ActiveScenario>
<CreatedDate>2026-08-03T22:26:57.9251327+00:00</CreatedDate>
<JobKey>f5c61855-0830-4df2-99f3-e09a11bfd025</JobKey>
<JobName>sample string 2</JobName>
<JobNumber>sample string 3</JobNumber>
<QuoteNumber>sample string 4</QuoteNumber>
<Scenarios>
<ApiScenarioListItem>
<CreatedDate>2026-08-03T22:26:57.9251327+00:00</CreatedDate>
<JobName>sample string 3</JobName>
<ScenarioKey>c02e76fa-cfff-467f-80d5-b77901122d54</ScenarioKey>
<ScenarioName>sample string 2</ScenarioName>
<UpdatedDate>2026-08-03T22:26:57.9251327+00:00</UpdatedDate>
</ApiScenarioListItem>
<ApiScenarioListItem>
<CreatedDate>2026-08-03T22:26:57.9251327+00:00</CreatedDate>
<JobName>sample string 3</JobName>
<ScenarioKey>c02e76fa-cfff-467f-80d5-b77901122d54</ScenarioKey>
<ScenarioName>sample string 2</ScenarioName>
<UpdatedDate>2026-08-03T22:26:57.9251327+00:00</UpdatedDate>
</ApiScenarioListItem>
</Scenarios>
<UpdatedDate>2026-08-03T22:26:57.9251327+00:00</UpdatedDate>
</ApiJobListItem>
<ApiJobListItem>
<ActiveScenario>true</ActiveScenario>
<CreatedDate>2026-08-03T22:26:57.9251327+00:00</CreatedDate>
<JobKey>f5c61855-0830-4df2-99f3-e09a11bfd025</JobKey>
<JobName>sample string 2</JobName>
<JobNumber>sample string 3</JobNumber>
<QuoteNumber>sample string 4</QuoteNumber>
<Scenarios>
<ApiScenarioListItem>
<CreatedDate>2026-08-03T22:26:57.9251327+00:00</CreatedDate>
<JobName>sample string 3</JobName>
<ScenarioKey>c02e76fa-cfff-467f-80d5-b77901122d54</ScenarioKey>
<ScenarioName>sample string 2</ScenarioName>
<UpdatedDate>2026-08-03T22:26:57.9251327+00:00</UpdatedDate>
</ApiScenarioListItem>
<ApiScenarioListItem>
<CreatedDate>2026-08-03T22:26:57.9251327+00:00</CreatedDate>
<JobName>sample string 3</JobName>
<ScenarioKey>c02e76fa-cfff-467f-80d5-b77901122d54</ScenarioKey>
<ScenarioName>sample string 2</ScenarioName>
<UpdatedDate>2026-08-03T22:26:57.9251327+00:00</UpdatedDate>
</ApiScenarioListItem>
</Scenarios>
<UpdatedDate>2026-08-03T22:26:57.9251327+00:00</UpdatedDate>
</ApiJobListItem>
</Jobs>
<ProjectKey>2314a9fd-1028-4f0c-bdff-b3ef53df2f14</ProjectKey>
<ProjectName>sample string 2</ProjectName>
</ApiProjectListItem>
<ApiProjectListItem>
<JobCount>3</JobCount>
<Jobs>
<ApiJobListItem>
<ActiveScenario>true</ActiveScenario>
<CreatedDate>2026-08-03T22:26:57.9251327+00:00</CreatedDate>
<JobKey>f5c61855-0830-4df2-99f3-e09a11bfd025</JobKey>
<JobName>sample string 2</JobName>
<JobNumber>sample string 3</JobNumber>
<QuoteNumber>sample string 4</QuoteNumber>
<Scenarios>
<ApiScenarioListItem>
<CreatedDate>2026-08-03T22:26:57.9251327+00:00</CreatedDate>
<JobName>sample string 3</JobName>
<ScenarioKey>c02e76fa-cfff-467f-80d5-b77901122d54</ScenarioKey>
<ScenarioName>sample string 2</ScenarioName>
<UpdatedDate>2026-08-03T22:26:57.9251327+00:00</UpdatedDate>
</ApiScenarioListItem>
<ApiScenarioListItem>
<CreatedDate>2026-08-03T22:26:57.9251327+00:00</CreatedDate>
<JobName>sample string 3</JobName>
<ScenarioKey>c02e76fa-cfff-467f-80d5-b77901122d54</ScenarioKey>
<ScenarioName>sample string 2</ScenarioName>
<UpdatedDate>2026-08-03T22:26:57.9251327+00:00</UpdatedDate>
</ApiScenarioListItem>
</Scenarios>
<UpdatedDate>2026-08-03T22:26:57.9251327+00:00</UpdatedDate>
</ApiJobListItem>
<ApiJobListItem>
<ActiveScenario>true</ActiveScenario>
<CreatedDate>2026-08-03T22:26:57.9251327+00:00</CreatedDate>
<JobKey>f5c61855-0830-4df2-99f3-e09a11bfd025</JobKey>
<JobName>sample string 2</JobName>
<JobNumber>sample string 3</JobNumber>
<QuoteNumber>sample string 4</QuoteNumber>
<Scenarios>
<ApiScenarioListItem>
<CreatedDate>2026-08-03T22:26:57.9251327+00:00</CreatedDate>
<JobName>sample string 3</JobName>
<ScenarioKey>c02e76fa-cfff-467f-80d5-b77901122d54</ScenarioKey>
<ScenarioName>sample string 2</ScenarioName>
<UpdatedDate>2026-08-03T22:26:57.9251327+00:00</UpdatedDate>
</ApiScenarioListItem>
<ApiScenarioListItem>
<CreatedDate>2026-08-03T22:26:57.9251327+00:00</CreatedDate>
<JobName>sample string 3</JobName>
<ScenarioKey>c02e76fa-cfff-467f-80d5-b77901122d54</ScenarioKey>
<ScenarioName>sample string 2</ScenarioName>
<UpdatedDate>2026-08-03T22:26:57.9251327+00:00</UpdatedDate>
</ApiScenarioListItem>
</Scenarios>
<UpdatedDate>2026-08-03T22:26:57.9251327+00:00</UpdatedDate>
</ApiJobListItem>
</Jobs>
<ProjectKey>2314a9fd-1028-4f0c-bdff-b3ef53df2f14</ProjectKey>
<ProjectName>sample string 2</ProjectName>
</ApiProjectListItem>
</Projects>
</ApiProjectListResponse>