POST api/Site/GrabSiteWindow
Request Information
URI Parameters
None.
Body Parameters
SiteViewModel| Name | Description | Type | Additional information |
|---|---|---|---|
| Site | SiteDto |
None. |
|
| BuildingCodes | Collection of LookupDto |
None. |
|
| IsDirty | boolean |
None. |
|
| RecalculateLaborMaterials | boolean |
None. |
|
| MacroNotifications | NotificationResponseDto |
None. |
|
| SharedCheckBox | CheckBoxDto |
None. |
Request Formats
application/json, text/json
Sample:
{
"sharedCheckBox": {
"checked": true,
"visible": true,
"enabled": true,
"caption": "sample string 4"
},
"site": {
"id": 1,
"jobId": 2,
"measureDate": "2026-08-03T22:27:40.9932191+00:00",
"measureTime": "sample string 3",
"siteContact": "sample string 4",
"street": "sample string 5",
"suburb": "sample string 6",
"city": "sample string 7",
"state": "sample string 8",
"zip": "sample string 9",
"mapRef": "sample string 10",
"crossStreet": "sample string 11",
"phone": "sample string 12",
"mobile": "sample string 13",
"buildCode": "sample string 14",
"isNewHome": true,
"siteNote1": "sample string 15",
"siteNote2": "sample string 16",
"siteEmail": "sample string 17",
"measureDateStr": "sample string 18"
},
"buildingCodes": [
{
"id": 1,
"idString": "sample string 2",
"name": "sample string 3",
"parentId": "sample string 4",
"description": "sample string 5",
"selected": true,
"sortIndex": 7,
"uniqueId": "88d6cea9-b73f-4b26-a5a5-cd11cf588724",
"parentUid": "c4f52c3e-d200-4e88-80fa-84249f006a5c",
"clientDefaultContactUid": "7b899cbd-1349-4ba6-b6da-f638d50a641f"
},
{
"id": 1,
"idString": "sample string 2",
"name": "sample string 3",
"parentId": "sample string 4",
"description": "sample string 5",
"selected": true,
"sortIndex": 7,
"uniqueId": "88d6cea9-b73f-4b26-a5a5-cd11cf588724",
"parentUid": "c4f52c3e-d200-4e88-80fa-84249f006a5c",
"clientDefaultContactUid": "7b899cbd-1349-4ba6-b6da-f638d50a641f"
}
],
"isDirty": true,
"recalculateLaborMaterials": true,
"macroNotifications": {
"responseType": 0,
"value": "sample string 1",
"isMacro": true,
"macroName": "sample string 3",
"checkbox": [
{
"checked": true,
"visible": true,
"enabled": true,
"caption": "sample string 4"
},
{
"checked": true,
"visible": true,
"enabled": true,
"caption": "sample string 4"
}
],
"showDestinationError": true,
"showTravelRequired": true,
"showOverrideTruckAlert": true,
"showWrongStateAlert": true,
"showVicAshAlert": true,
"showBuildersMarginAlert": true,
"showUpdateOrStandardAlert": true,
"updatePricing": true,
"continueToWhichFunction": "sample string 12",
"macroAlertMessage": "sample string 13",
"identifier": "sample string 14"
}
}
application/xml, text/xml
Sample:
<SiteViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/StairBiz.Contracts.ViewModels">
<BuildingCodes xmlns:d2p1="http://schemas.datacontract.org/2004/07/StairBiz.Contracts.Dto">
<d2p1:LookupDto>
<d2p1:_x003C_ClientDefaultContactUid_x003E_k__BackingField>7b899cbd-1349-4ba6-b6da-f638d50a641f</d2p1:_x003C_ClientDefaultContactUid_x003E_k__BackingField>
<d2p1:_x003C_Description_x003E_k__BackingField>sample string 5</d2p1:_x003C_Description_x003E_k__BackingField>
<d2p1:_x003C_IdString_x003E_k__BackingField>sample string 2</d2p1:_x003C_IdString_x003E_k__BackingField>
<d2p1:_x003C_Id_x003E_k__BackingField>1</d2p1:_x003C_Id_x003E_k__BackingField>
<d2p1:_x003C_Name_x003E_k__BackingField>sample string 3</d2p1:_x003C_Name_x003E_k__BackingField>
<d2p1:_x003C_ParentId_x003E_k__BackingField>sample string 4</d2p1:_x003C_ParentId_x003E_k__BackingField>
<d2p1:_x003C_ParentUid_x003E_k__BackingField>c4f52c3e-d200-4e88-80fa-84249f006a5c</d2p1:_x003C_ParentUid_x003E_k__BackingField>
<d2p1:_x003C_Selected_x003E_k__BackingField>true</d2p1:_x003C_Selected_x003E_k__BackingField>
<d2p1:_x003C_SortIndex_x003E_k__BackingField>7</d2p1:_x003C_SortIndex_x003E_k__BackingField>
<d2p1:_x003C_UniqueId_x003E_k__BackingField>88d6cea9-b73f-4b26-a5a5-cd11cf588724</d2p1:_x003C_UniqueId_x003E_k__BackingField>
</d2p1:LookupDto>
<d2p1:LookupDto>
<d2p1:_x003C_ClientDefaultContactUid_x003E_k__BackingField>7b899cbd-1349-4ba6-b6da-f638d50a641f</d2p1:_x003C_ClientDefaultContactUid_x003E_k__BackingField>
<d2p1:_x003C_Description_x003E_k__BackingField>sample string 5</d2p1:_x003C_Description_x003E_k__BackingField>
<d2p1:_x003C_IdString_x003E_k__BackingField>sample string 2</d2p1:_x003C_IdString_x003E_k__BackingField>
<d2p1:_x003C_Id_x003E_k__BackingField>1</d2p1:_x003C_Id_x003E_k__BackingField>
<d2p1:_x003C_Name_x003E_k__BackingField>sample string 3</d2p1:_x003C_Name_x003E_k__BackingField>
<d2p1:_x003C_ParentId_x003E_k__BackingField>sample string 4</d2p1:_x003C_ParentId_x003E_k__BackingField>
<d2p1:_x003C_ParentUid_x003E_k__BackingField>c4f52c3e-d200-4e88-80fa-84249f006a5c</d2p1:_x003C_ParentUid_x003E_k__BackingField>
<d2p1:_x003C_Selected_x003E_k__BackingField>true</d2p1:_x003C_Selected_x003E_k__BackingField>
<d2p1:_x003C_SortIndex_x003E_k__BackingField>7</d2p1:_x003C_SortIndex_x003E_k__BackingField>
<d2p1:_x003C_UniqueId_x003E_k__BackingField>88d6cea9-b73f-4b26-a5a5-cd11cf588724</d2p1:_x003C_UniqueId_x003E_k__BackingField>
</d2p1:LookupDto>
</BuildingCodes>
<IsDirty>true</IsDirty>
<MacroNotifications xmlns:d2p1="http://schemas.datacontract.org/2004/07/StairBiz.Contracts.Dto.Parameter">
<d2p1:Checkbox xmlns:d3p1="http://schemas.datacontract.org/2004/07/StairBiz.Contracts.Dto.Controls">
<d3p1:CheckBoxDto>
<d3p1:Caption>sample string 4</d3p1:Caption>
<d3p1:Checked>true</d3p1:Checked>
<d3p1:Enabled>true</d3p1:Enabled>
<d3p1:Visible>true</d3p1:Visible>
</d3p1:CheckBoxDto>
<d3p1:CheckBoxDto>
<d3p1:Caption>sample string 4</d3p1:Caption>
<d3p1:Checked>true</d3p1:Checked>
<d3p1:Enabled>true</d3p1:Enabled>
<d3p1:Visible>true</d3p1:Visible>
</d3p1:CheckBoxDto>
</d2p1:Checkbox>
<d2p1:ContinueToWhichFunction>sample string 12</d2p1:ContinueToWhichFunction>
<d2p1:Identifier>sample string 14</d2p1:Identifier>
<d2p1:IsMacro>true</d2p1:IsMacro>
<d2p1:MacroAlertMessage>sample string 13</d2p1:MacroAlertMessage>
<d2p1:MacroName>sample string 3</d2p1:MacroName>
<d2p1:ResponseType>Null</d2p1:ResponseType>
<d2p1:ShowBuildersMarginAlert>true</d2p1:ShowBuildersMarginAlert>
<d2p1:ShowDestinationError>true</d2p1:ShowDestinationError>
<d2p1:ShowOverrideTruckAlert>true</d2p1:ShowOverrideTruckAlert>
<d2p1:ShowTravelRequired>true</d2p1:ShowTravelRequired>
<d2p1:ShowUpdateOrStandardAlert>true</d2p1:ShowUpdateOrStandardAlert>
<d2p1:ShowVicAshAlert>true</d2p1:ShowVicAshAlert>
<d2p1:ShowWrongStateAlert>true</d2p1:ShowWrongStateAlert>
<d2p1:UpdatePricing>true</d2p1:UpdatePricing>
<d2p1:Value>sample string 1</d2p1:Value>
</MacroNotifications>
<RecalculateLaborMaterials>true</RecalculateLaborMaterials>
<SharedCheckBox xmlns:d2p1="http://schemas.datacontract.org/2004/07/StairBiz.Contracts.Dto.Controls">
<d2p1:Caption>sample string 4</d2p1:Caption>
<d2p1:Checked>true</d2p1:Checked>
<d2p1:Enabled>true</d2p1:Enabled>
<d2p1:Visible>true</d2p1:Visible>
</SharedCheckBox>
<Site xmlns:d2p1="http://schemas.datacontract.org/2004/07/StairBiz.Contracts.Dto">
<d2p1:BuildCode>sample string 14</d2p1:BuildCode>
<d2p1:City>sample string 7</d2p1:City>
<d2p1:CrossStreet>sample string 11</d2p1:CrossStreet>
<d2p1:Id>1</d2p1:Id>
<d2p1:IsNewHome>true</d2p1:IsNewHome>
<d2p1:JobId>2</d2p1:JobId>
<d2p1:MapRef>sample string 10</d2p1:MapRef>
<d2p1:MeasureDate>2026-08-03T22:27:40.9932191+00:00</d2p1:MeasureDate>
<d2p1:MeasureDateStr>sample string 18</d2p1:MeasureDateStr>
<d2p1:MeasureTime>sample string 3</d2p1:MeasureTime>
<d2p1:Mobile>sample string 13</d2p1:Mobile>
<d2p1:Phone>sample string 12</d2p1:Phone>
<d2p1:SiteContact>sample string 4</d2p1:SiteContact>
<d2p1:SiteEmail>sample string 17</d2p1:SiteEmail>
<d2p1:SiteNote1>sample string 15</d2p1:SiteNote1>
<d2p1:SiteNote2>sample string 16</d2p1:SiteNote2>
<d2p1:State>sample string 8</d2p1:State>
<d2p1:Street>sample string 5</d2p1:Street>
<d2p1:Suburb>sample string 6</d2p1:Suburb>
<d2p1:Zip>sample string 9</d2p1:Zip>
</Site>
</SiteViewModel>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
SiteViewModel| Name | Description | Type | Additional information |
|---|---|---|---|
| Site | SiteDto |
None. |
|
| BuildingCodes | Collection of LookupDto |
None. |
|
| IsDirty | boolean |
None. |
|
| RecalculateLaborMaterials | boolean |
None. |
|
| MacroNotifications | NotificationResponseDto |
None. |
|
| SharedCheckBox | CheckBoxDto |
None. |
Response Formats
application/json, text/json
Sample:
{
"sharedCheckBox": {
"checked": true,
"visible": true,
"enabled": true,
"caption": "sample string 4"
},
"site": {
"id": 1,
"jobId": 2,
"measureDate": "2026-08-03T22:27:40.9932191+00:00",
"measureTime": "sample string 3",
"siteContact": "sample string 4",
"street": "sample string 5",
"suburb": "sample string 6",
"city": "sample string 7",
"state": "sample string 8",
"zip": "sample string 9",
"mapRef": "sample string 10",
"crossStreet": "sample string 11",
"phone": "sample string 12",
"mobile": "sample string 13",
"buildCode": "sample string 14",
"isNewHome": true,
"siteNote1": "sample string 15",
"siteNote2": "sample string 16",
"siteEmail": "sample string 17",
"measureDateStr": "sample string 18"
},
"buildingCodes": [
{
"id": 1,
"idString": "sample string 2",
"name": "sample string 3",
"parentId": "sample string 4",
"description": "sample string 5",
"selected": true,
"sortIndex": 7,
"uniqueId": "706fc56a-83c7-45c0-9129-69fba1735aa1",
"parentUid": "8634c9dd-cb9f-4c59-b96d-c721fb8e7987",
"clientDefaultContactUid": "b3fb8e97-7f1a-4fd6-91f3-a59012740179"
},
{
"id": 1,
"idString": "sample string 2",
"name": "sample string 3",
"parentId": "sample string 4",
"description": "sample string 5",
"selected": true,
"sortIndex": 7,
"uniqueId": "706fc56a-83c7-45c0-9129-69fba1735aa1",
"parentUid": "8634c9dd-cb9f-4c59-b96d-c721fb8e7987",
"clientDefaultContactUid": "b3fb8e97-7f1a-4fd6-91f3-a59012740179"
}
],
"isDirty": true,
"recalculateLaborMaterials": true,
"macroNotifications": {
"responseType": 0,
"value": "sample string 1",
"isMacro": true,
"macroName": "sample string 3",
"checkbox": [
{
"checked": true,
"visible": true,
"enabled": true,
"caption": "sample string 4"
},
{
"checked": true,
"visible": true,
"enabled": true,
"caption": "sample string 4"
}
],
"showDestinationError": true,
"showTravelRequired": true,
"showOverrideTruckAlert": true,
"showWrongStateAlert": true,
"showVicAshAlert": true,
"showBuildersMarginAlert": true,
"showUpdateOrStandardAlert": true,
"updatePricing": true,
"continueToWhichFunction": "sample string 12",
"macroAlertMessage": "sample string 13",
"identifier": "sample string 14"
}
}
application/xml, text/xml
Sample:
<SiteViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/StairBiz.Contracts.ViewModels">
<BuildingCodes xmlns:d2p1="http://schemas.datacontract.org/2004/07/StairBiz.Contracts.Dto">
<d2p1:LookupDto>
<d2p1:_x003C_ClientDefaultContactUid_x003E_k__BackingField>b3fb8e97-7f1a-4fd6-91f3-a59012740179</d2p1:_x003C_ClientDefaultContactUid_x003E_k__BackingField>
<d2p1:_x003C_Description_x003E_k__BackingField>sample string 5</d2p1:_x003C_Description_x003E_k__BackingField>
<d2p1:_x003C_IdString_x003E_k__BackingField>sample string 2</d2p1:_x003C_IdString_x003E_k__BackingField>
<d2p1:_x003C_Id_x003E_k__BackingField>1</d2p1:_x003C_Id_x003E_k__BackingField>
<d2p1:_x003C_Name_x003E_k__BackingField>sample string 3</d2p1:_x003C_Name_x003E_k__BackingField>
<d2p1:_x003C_ParentId_x003E_k__BackingField>sample string 4</d2p1:_x003C_ParentId_x003E_k__BackingField>
<d2p1:_x003C_ParentUid_x003E_k__BackingField>8634c9dd-cb9f-4c59-b96d-c721fb8e7987</d2p1:_x003C_ParentUid_x003E_k__BackingField>
<d2p1:_x003C_Selected_x003E_k__BackingField>true</d2p1:_x003C_Selected_x003E_k__BackingField>
<d2p1:_x003C_SortIndex_x003E_k__BackingField>7</d2p1:_x003C_SortIndex_x003E_k__BackingField>
<d2p1:_x003C_UniqueId_x003E_k__BackingField>706fc56a-83c7-45c0-9129-69fba1735aa1</d2p1:_x003C_UniqueId_x003E_k__BackingField>
</d2p1:LookupDto>
<d2p1:LookupDto>
<d2p1:_x003C_ClientDefaultContactUid_x003E_k__BackingField>b3fb8e97-7f1a-4fd6-91f3-a59012740179</d2p1:_x003C_ClientDefaultContactUid_x003E_k__BackingField>
<d2p1:_x003C_Description_x003E_k__BackingField>sample string 5</d2p1:_x003C_Description_x003E_k__BackingField>
<d2p1:_x003C_IdString_x003E_k__BackingField>sample string 2</d2p1:_x003C_IdString_x003E_k__BackingField>
<d2p1:_x003C_Id_x003E_k__BackingField>1</d2p1:_x003C_Id_x003E_k__BackingField>
<d2p1:_x003C_Name_x003E_k__BackingField>sample string 3</d2p1:_x003C_Name_x003E_k__BackingField>
<d2p1:_x003C_ParentId_x003E_k__BackingField>sample string 4</d2p1:_x003C_ParentId_x003E_k__BackingField>
<d2p1:_x003C_ParentUid_x003E_k__BackingField>8634c9dd-cb9f-4c59-b96d-c721fb8e7987</d2p1:_x003C_ParentUid_x003E_k__BackingField>
<d2p1:_x003C_Selected_x003E_k__BackingField>true</d2p1:_x003C_Selected_x003E_k__BackingField>
<d2p1:_x003C_SortIndex_x003E_k__BackingField>7</d2p1:_x003C_SortIndex_x003E_k__BackingField>
<d2p1:_x003C_UniqueId_x003E_k__BackingField>706fc56a-83c7-45c0-9129-69fba1735aa1</d2p1:_x003C_UniqueId_x003E_k__BackingField>
</d2p1:LookupDto>
</BuildingCodes>
<IsDirty>true</IsDirty>
<MacroNotifications xmlns:d2p1="http://schemas.datacontract.org/2004/07/StairBiz.Contracts.Dto.Parameter">
<d2p1:Checkbox xmlns:d3p1="http://schemas.datacontract.org/2004/07/StairBiz.Contracts.Dto.Controls">
<d3p1:CheckBoxDto>
<d3p1:Caption>sample string 4</d3p1:Caption>
<d3p1:Checked>true</d3p1:Checked>
<d3p1:Enabled>true</d3p1:Enabled>
<d3p1:Visible>true</d3p1:Visible>
</d3p1:CheckBoxDto>
<d3p1:CheckBoxDto>
<d3p1:Caption>sample string 4</d3p1:Caption>
<d3p1:Checked>true</d3p1:Checked>
<d3p1:Enabled>true</d3p1:Enabled>
<d3p1:Visible>true</d3p1:Visible>
</d3p1:CheckBoxDto>
</d2p1:Checkbox>
<d2p1:ContinueToWhichFunction>sample string 12</d2p1:ContinueToWhichFunction>
<d2p1:Identifier>sample string 14</d2p1:Identifier>
<d2p1:IsMacro>true</d2p1:IsMacro>
<d2p1:MacroAlertMessage>sample string 13</d2p1:MacroAlertMessage>
<d2p1:MacroName>sample string 3</d2p1:MacroName>
<d2p1:ResponseType>Null</d2p1:ResponseType>
<d2p1:ShowBuildersMarginAlert>true</d2p1:ShowBuildersMarginAlert>
<d2p1:ShowDestinationError>true</d2p1:ShowDestinationError>
<d2p1:ShowOverrideTruckAlert>true</d2p1:ShowOverrideTruckAlert>
<d2p1:ShowTravelRequired>true</d2p1:ShowTravelRequired>
<d2p1:ShowUpdateOrStandardAlert>true</d2p1:ShowUpdateOrStandardAlert>
<d2p1:ShowVicAshAlert>true</d2p1:ShowVicAshAlert>
<d2p1:ShowWrongStateAlert>true</d2p1:ShowWrongStateAlert>
<d2p1:UpdatePricing>true</d2p1:UpdatePricing>
<d2p1:Value>sample string 1</d2p1:Value>
</MacroNotifications>
<RecalculateLaborMaterials>true</RecalculateLaborMaterials>
<SharedCheckBox xmlns:d2p1="http://schemas.datacontract.org/2004/07/StairBiz.Contracts.Dto.Controls">
<d2p1:Caption>sample string 4</d2p1:Caption>
<d2p1:Checked>true</d2p1:Checked>
<d2p1:Enabled>true</d2p1:Enabled>
<d2p1:Visible>true</d2p1:Visible>
</SharedCheckBox>
<Site xmlns:d2p1="http://schemas.datacontract.org/2004/07/StairBiz.Contracts.Dto">
<d2p1:BuildCode>sample string 14</d2p1:BuildCode>
<d2p1:City>sample string 7</d2p1:City>
<d2p1:CrossStreet>sample string 11</d2p1:CrossStreet>
<d2p1:Id>1</d2p1:Id>
<d2p1:IsNewHome>true</d2p1:IsNewHome>
<d2p1:JobId>2</d2p1:JobId>
<d2p1:MapRef>sample string 10</d2p1:MapRef>
<d2p1:MeasureDate>2026-08-03T22:27:40.9932191+00:00</d2p1:MeasureDate>
<d2p1:MeasureDateStr>sample string 18</d2p1:MeasureDateStr>
<d2p1:MeasureTime>sample string 3</d2p1:MeasureTime>
<d2p1:Mobile>sample string 13</d2p1:Mobile>
<d2p1:Phone>sample string 12</d2p1:Phone>
<d2p1:SiteContact>sample string 4</d2p1:SiteContact>
<d2p1:SiteEmail>sample string 17</d2p1:SiteEmail>
<d2p1:SiteNote1>sample string 15</d2p1:SiteNote1>
<d2p1:SiteNote2>sample string 16</d2p1:SiteNote2>
<d2p1:State>sample string 8</d2p1:State>
<d2p1:Street>sample string 5</d2p1:Street>
<d2p1:Suburb>sample string 6</d2p1:Suburb>
<d2p1:Zip>sample string 9</d2p1:Zip>
</Site>
</SiteViewModel>