POST api/StringsSetout/DrawUserDimension

Request Information

URI Parameters

None.

Body Parameters

MouseUpParameterDto
NameDescriptionTypeAdditional information
StartX

integer

None.
StartY

integer

None.
EndX

integer

None.
EndY

integer

None.
JunctionId

integer

None.
LineId

integer

None.
DimmingId

integer

None.
SelectionName

string

None.
KeyPress

KeyPressParameters

None.
ClickX

integer

None.
ClickY

integer

None.
NotificationResponse

NotificationResponseDto

None.

Request Formats

application/json, text/json

Sample: 
{
  "startX": 1,
  "startY": 2,
  "endX": 3,
  "endY": 4,
  "junctionId": 5,
  "lineId": 6,
  "dimmingId": 7,
  "selectionName": "sample string 8",
  "keyPress": {
    "ctrlKey": true,
    "shiftKey": true,
    "altKey": true
  },
  "clickX": 9,
  "clickY": 10,
  "notificationResponse": {
    "responseType": 0,
    "value": "sample string 1"
  }
}

application/xml, text/xml

Sample: 
<MouseUpParameterDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/StairBiz.Contracts.Dto.Parameter">
  <ClickX>9</ClickX>
  <ClickY>10</ClickY>
  <DimmingId>7</DimmingId>
  <EndX>3</EndX>
  <EndY>4</EndY>
  <JunctionId>5</JunctionId>
  <KeyPress>
    <AltKey>true</AltKey>
    <CtrlKey>true</CtrlKey>
    <ShiftKey>true</ShiftKey>
  </KeyPress>
  <LineId>6</LineId>
  <NotificationResponse>
    <ResponseType>Null</ResponseType>
    <Value>sample string 1</Value>
  </NotificationResponse>
  <SelectionName>sample string 8</SelectionName>
  <StartX>1</StartX>
  <StartY>2</StartY>
</MouseUpParameterDto>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

StringSetoutViewModel
NameDescriptionTypeAdditional information
EditMode

integer

None.
MainDrawing

string

None.
StgPrevNextButtonSelected

integer

None.
TenonCountLabel

string

None.
WallCountLabel

string

None.
ZoomParameter

ZoomParameterDto

None.
Notification

NotificationDto

None.
Theme

string

None.
BackGroundColor

string

None.
isReverse

boolean

None.
TenonPreviousButton

CommandButtonDto

None.
TenonNextButton

CommandButtonDto

None.
WallPreviousButton

CommandButtonDto

None.
WallNextButton

CommandButtonDto

None.
ShowDoneCheckBox

CheckBoxDto

None.
DoneHiCheckBox

CheckBoxDto

None.
DoneHiCheckBoxLeft

string

None.
DoneLoCheckBox

CheckBoxDto

None.
DoneLoCheckBoxLeft

string

None.
ClearUnitButton

CommandButtonDto

None.
ClearStairButton

CommandButtonDto

None.
SelectExtendHi

DropDownBoxDto

None.
SelectExtendLo

DropDownBoxDto

None.

Response Formats

application/json, text/json

Sample: 
{
  "tenonPreviousButton": {
    "visible": true,
    "enabled": true,
    "caption": "sample string 3"
  },
  "tenonNextButton": {
    "visible": true,
    "enabled": true,
    "caption": "sample string 3"
  },
  "wallPreviousButton": {
    "visible": true,
    "enabled": true,
    "caption": "sample string 3"
  },
  "wallNextButton": {
    "visible": true,
    "enabled": true,
    "caption": "sample string 3"
  },
  "showDoneCheckBox": {
    "checked": true,
    "visible": true,
    "enabled": true,
    "caption": "sample string 4"
  },
  "doneHiCheckBox": {
    "checked": true,
    "visible": true,
    "enabled": true,
    "caption": "sample string 4"
  },
  "doneHiCheckBoxLeft": "sample string 1",
  "doneLoCheckBox": {
    "checked": true,
    "visible": true,
    "enabled": true,
    "caption": "sample string 4"
  },
  "doneLoCheckBoxLeft": "sample string 2",
  "clearUnitButton": {
    "visible": true,
    "enabled": true,
    "caption": "sample string 3"
  },
  "clearStairButton": {
    "visible": true,
    "enabled": true,
    "caption": "sample string 3"
  },
  "selectExtendHi": {
    "visible": true,
    "enabled": true,
    "items": [
      "sample string 1",
      "sample string 2"
    ],
    "guids": [
      "3bf08595-de93-472f-b984-c61f6cbbcfb9",
      "c84a225a-140e-4724-81a0-6995e0c0ac89"
    ],
    "selectedIndex": 1,
    "selectedItem": "sample string 3",
    "filterUid": "82cd3fff-4b47-4049-97df-ccf1937a0b58"
  },
  "selectExtendLo": {
    "visible": true,
    "enabled": true,
    "items": [
      "sample string 1",
      "sample string 2"
    ],
    "guids": [
      "3bf08595-de93-472f-b984-c61f6cbbcfb9",
      "c84a225a-140e-4724-81a0-6995e0c0ac89"
    ],
    "selectedIndex": 1,
    "selectedItem": "sample string 3",
    "filterUid": "82cd3fff-4b47-4049-97df-ccf1937a0b58"
  },
  "editMode": 1,
  "mainDrawing": "sample string 2",
  "stgPrevNextButtonSelected": 3,
  "tenonCountLabel": "sample string 4",
  "wallCountLabel": "sample string 5",
  "zoomParameter": {
    "startX": 1,
    "startY": 2,
    "endX": 3,
    "endY": 4,
    "canvasHeight": 5,
    "canvasWidth": 6,
    "ctrlPress": true
  },
  "notification": {
    "title": "sample string 1",
    "description": "sample string 2",
    "type": 0
  },
  "theme": "sample string 6",
  "backGroundColor": "sample string 7",
  "isReverse": true
}

application/xml, text/xml

Sample: 
<StringSetoutViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/StairBiz.Contracts.ViewModels">
  <BackGroundColor>sample string 7</BackGroundColor>
  <ClearStairButton xmlns:d2p1="http://schemas.datacontract.org/2004/07/StairBiz.Contracts.Dto.Controls">
    <d2p1:Caption>sample string 3</d2p1:Caption>
    <d2p1:Enabled>true</d2p1:Enabled>
    <d2p1:Visible>true</d2p1:Visible>
  </ClearStairButton>
  <ClearUnitButton xmlns:d2p1="http://schemas.datacontract.org/2004/07/StairBiz.Contracts.Dto.Controls">
    <d2p1:Caption>sample string 3</d2p1:Caption>
    <d2p1:Enabled>true</d2p1:Enabled>
    <d2p1:Visible>true</d2p1:Visible>
  </ClearUnitButton>
  <DoneHiCheckBox 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>
  </DoneHiCheckBox>
  <DoneHiCheckBoxLeft>sample string 1</DoneHiCheckBoxLeft>
  <DoneLoCheckBox 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>
  </DoneLoCheckBox>
  <DoneLoCheckBoxLeft>sample string 2</DoneLoCheckBoxLeft>
  <EditMode>1</EditMode>
  <MainDrawing>sample string 2</MainDrawing>
  <Notification xmlns:d2p1="http://schemas.datacontract.org/2004/07/StairBiz.Contracts.Dto.Common">
    <d2p1:_x003C_Description_x003E_k__BackingField>sample string 2</d2p1:_x003C_Description_x003E_k__BackingField>
    <d2p1:_x003C_Title_x003E_k__BackingField>sample string 1</d2p1:_x003C_Title_x003E_k__BackingField>
    <d2p1:_x003C_Type_x003E_k__BackingField>Default</d2p1:_x003C_Type_x003E_k__BackingField>
  </Notification>
  <SelectExtendHi xmlns:d2p1="http://schemas.datacontract.org/2004/07/StairBiz.Contracts.Dto.Controls">
    <d2p1:Enabled>true</d2p1:Enabled>
    <d2p1:FilterUid>82cd3fff-4b47-4049-97df-ccf1937a0b58</d2p1:FilterUid>
    <d2p1:Guids xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:guid>3bf08595-de93-472f-b984-c61f6cbbcfb9</d3p1:guid>
      <d3p1:guid>c84a225a-140e-4724-81a0-6995e0c0ac89</d3p1:guid>
    </d2p1:Guids>
    <d2p1:Items xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </d2p1:Items>
    <d2p1:SelectedIndex>1</d2p1:SelectedIndex>
    <d2p1:SelectedItem>sample string 3</d2p1:SelectedItem>
    <d2p1:Visible>true</d2p1:Visible>
  </SelectExtendHi>
  <SelectExtendLo xmlns:d2p1="http://schemas.datacontract.org/2004/07/StairBiz.Contracts.Dto.Controls">
    <d2p1:Enabled>true</d2p1:Enabled>
    <d2p1:FilterUid>82cd3fff-4b47-4049-97df-ccf1937a0b58</d2p1:FilterUid>
    <d2p1:Guids xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:guid>3bf08595-de93-472f-b984-c61f6cbbcfb9</d3p1:guid>
      <d3p1:guid>c84a225a-140e-4724-81a0-6995e0c0ac89</d3p1:guid>
    </d2p1:Guids>
    <d2p1:Items xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </d2p1:Items>
    <d2p1:SelectedIndex>1</d2p1:SelectedIndex>
    <d2p1:SelectedItem>sample string 3</d2p1:SelectedItem>
    <d2p1:Visible>true</d2p1:Visible>
  </SelectExtendLo>
  <ShowDoneCheckBox 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>
  </ShowDoneCheckBox>
  <StgPrevNextButtonSelected>3</StgPrevNextButtonSelected>
  <TenonCountLabel>sample string 4</TenonCountLabel>
  <TenonNextButton xmlns:d2p1="http://schemas.datacontract.org/2004/07/StairBiz.Contracts.Dto.Controls">
    <d2p1:Caption>sample string 3</d2p1:Caption>
    <d2p1:Enabled>true</d2p1:Enabled>
    <d2p1:Visible>true</d2p1:Visible>
  </TenonNextButton>
  <TenonPreviousButton xmlns:d2p1="http://schemas.datacontract.org/2004/07/StairBiz.Contracts.Dto.Controls">
    <d2p1:Caption>sample string 3</d2p1:Caption>
    <d2p1:Enabled>true</d2p1:Enabled>
    <d2p1:Visible>true</d2p1:Visible>
  </TenonPreviousButton>
  <Theme>sample string 6</Theme>
  <WallCountLabel>sample string 5</WallCountLabel>
  <WallNextButton xmlns:d2p1="http://schemas.datacontract.org/2004/07/StairBiz.Contracts.Dto.Controls">
    <d2p1:Caption>sample string 3</d2p1:Caption>
    <d2p1:Enabled>true</d2p1:Enabled>
    <d2p1:Visible>true</d2p1:Visible>
  </WallNextButton>
  <WallPreviousButton xmlns:d2p1="http://schemas.datacontract.org/2004/07/StairBiz.Contracts.Dto.Controls">
    <d2p1:Caption>sample string 3</d2p1:Caption>
    <d2p1:Enabled>true</d2p1:Enabled>
    <d2p1:Visible>true</d2p1:Visible>
  </WallPreviousButton>
  <ZoomParameter xmlns:d2p1="http://schemas.datacontract.org/2004/07/StairBiz.Contracts.Dto.Parameter">
    <d2p1:CanvasHeight>5</d2p1:CanvasHeight>
    <d2p1:CanvasWidth>6</d2p1:CanvasWidth>
    <d2p1:CtrlPress>true</d2p1:CtrlPress>
    <d2p1:EndX>3</d2p1:EndX>
    <d2p1:EndY>4</d2p1:EndY>
    <d2p1:StartX>1</d2p1:StartX>
    <d2p1:StartY>2</d2p1:StartY>
  </ZoomParameter>
  <isReverse>true</isReverse>
</StringSetoutViewModel>