POST api/LoadingAssistant/GenerateHeaderLoads

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
StructuralSystemValue	integer	None.
MemberTypeValue	integer	None.
LiveLoadSelections	Collection of Pair of integer [key] and string [value]	None.
LiveLoadClass	integer	None.
DeadMagPSI	string	None.
LiveMagPSI	string	None.
RoofFramingSelections	Collection of Pair of integer [key] and string [value]	None.
RoofFramingSystem	integer	None.
SideRoofSlope	string	None.
EndRoofSlope	string	None.
SideSetBack	string	None.
EndWallLength	string	None.
OverhangLocation	integer	None.
Overhang	string	None.
HeaderLocationSelections	Collection of Pair of integer [key] and string [value]	None.
HeaderLocation	integer	None.
DistanceFromWall	string	None.
HeaderLength	string	None.
ValidationType	integer	None.
ValidationMessage	string	None.
ValidationValue	string	None.
postResponseData	PostResponseDataSDO	None.

Request Formats

application/json, text/json, text/html

Sample:

{
  "StructuralSystemValue": 1,
  "MemberTypeValue": 2,
  "LiveLoadSelections": [
    {
      "Key": 1,
      "Value": "sample string 2"
    },
    {
      "Key": 1,
      "Value": "sample string 2"
    }
  ],
  "LiveLoadClass": 3,
  "DeadMagPSI": "sample string 4",
  "LiveMagPSI": "sample string 5",
  "RoofFramingSelections": [
    {
      "Key": 1,
      "Value": "sample string 2"
    },
    {
      "Key": 1,
      "Value": "sample string 2"
    }
  ],
  "RoofFramingSystem": 6,
  "SideRoofSlope": "sample string 7",
  "EndRoofSlope": "sample string 8",
  "SideSetBack": "sample string 9",
  "EndWallLength": "sample string 10",
  "OverhangLocation": 11,
  "Overhang": "sample string 12",
  "HeaderLocationSelections": [
    {
      "Key": 1,
      "Value": "sample string 2"
    },
    {
      "Key": 1,
      "Value": "sample string 2"
    }
  ],
  "HeaderLocation": 13,
  "DistanceFromWall": "sample string 14",
  "HeaderLength": "sample string 15",
  "ValidationType": 16,
  "ValidationMessage": "sample string 17",
  "ValidationValue": "sample string 18",
  "postResponseData": {
    "IsPostResponseDataObject": 1,
    "FileHash": "sample string 1",
    "ApplicationData": null,
    "MemberData": null
  }
}

application/xml, text/xml

Sample:

<LoadingAssistantHeaderViewModelData xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/iLevel.Vitruvius.VitruviusPubLib.BindingModels.LoadingAssistant">
  <DeadMagPSI>sample string 4</DeadMagPSI>
  <DistanceFromWall>sample string 14</DistanceFromWall>
  <EndRoofSlope>sample string 8</EndRoofSlope>
  <EndWallLength>sample string 10</EndWallLength>
  <HeaderLength>sample string 15</HeaderLength>
  <HeaderLocation>13</HeaderLocation>
  <HeaderLocationSelections xmlns:d2p1="http://schemas.datacontract.org/2004/07/System.Collections.Generic">
    <d2p1:KeyValuePairOfintstring>
      <d2p1:key>1</d2p1:key>
      <d2p1:value>sample string 2</d2p1:value>
    </d2p1:KeyValuePairOfintstring>
    <d2p1:KeyValuePairOfintstring>
      <d2p1:key>1</d2p1:key>
      <d2p1:value>sample string 2</d2p1:value>
    </d2p1:KeyValuePairOfintstring>
  </HeaderLocationSelections>
  <LiveLoadClass>3</LiveLoadClass>
  <LiveLoadSelections xmlns:d2p1="http://schemas.datacontract.org/2004/07/System.Collections.Generic">
    <d2p1:KeyValuePairOfintstring>
      <d2p1:key>1</d2p1:key>
      <d2p1:value>sample string 2</d2p1:value>
    </d2p1:KeyValuePairOfintstring>
    <d2p1:KeyValuePairOfintstring>
      <d2p1:key>1</d2p1:key>
      <d2p1:value>sample string 2</d2p1:value>
    </d2p1:KeyValuePairOfintstring>
  </LiveLoadSelections>
  <LiveMagPSI>sample string 5</LiveMagPSI>
  <MemberTypeValue>2</MemberTypeValue>
  <Overhang>sample string 12</Overhang>
  <OverhangLocation>11</OverhangLocation>
  <RoofFramingSelections xmlns:d2p1="http://schemas.datacontract.org/2004/07/System.Collections.Generic">
    <d2p1:KeyValuePairOfintstring>
      <d2p1:key>1</d2p1:key>
      <d2p1:value>sample string 2</d2p1:value>
    </d2p1:KeyValuePairOfintstring>
    <d2p1:KeyValuePairOfintstring>
      <d2p1:key>1</d2p1:key>
      <d2p1:value>sample string 2</d2p1:value>
    </d2p1:KeyValuePairOfintstring>
  </RoofFramingSelections>
  <RoofFramingSystem>6</RoofFramingSystem>
  <SideRoofSlope>sample string 7</SideRoofSlope>
  <SideSetBack>sample string 9</SideSetBack>
  <StructuralSystemValue>1</StructuralSystemValue>
  <ValidationMessage>sample string 17</ValidationMessage>
  <ValidationType>16</ValidationType>
  <ValidationValue>sample string 18</ValidationValue>
  <postResponseData xmlns:d2p1="http://schemas.datacontract.org/2004/07/iLevel.Vitruvius.VitruviusPubLib">
    <d2p1:_ApplicationData i:nil="true" />
    <d2p1:_FileHash>sample string 1</d2p1:_FileHash>
    <d2p1:_MemberData i:nil="true" />
  </postResponseData>
</LoadingAssistantHeaderViewModelData>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

HttpResponseMessage

Name	Type	Additional information
Version	Version	None.
Content	HttpContent	None.
StatusCode	HttpStatusCode	None.
ReasonPhrase	string	None.
Headers	Collection of Object	None.
RequestMessage	HttpRequestMessage	None.
IsSuccessStatusCode	boolean	None.