POST api/Project/TriggerMacro

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
ResponseType	NotificationResponseEnum	None.
Value	string	None.
IsMacro	boolean	None.
MacroName	string	None.
Checkbox	Collection of CheckBoxDto	None.
ShowDestinationError	boolean	None.
ShowTravelRequired	boolean	None.
ShowOverrideTruckAlert	boolean	None.
ShowWrongStateAlert	boolean	None.
ShowVicAshAlert	boolean	None.
ShowBuildersMarginAlert	boolean	None.
ShowUpdateOrStandardAlert	boolean	None.
UpdatePricing	boolean	None.
ContinueToWhichFunction	string	None.
MacroAlertMessage	string	None.
Identifier	string	None.

Request Formats

application/json, text/json

Sample:

{
  "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:

<NotificationResponseDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/StairBiz.Contracts.Dto.Parameter">
  <Checkbox xmlns:d2p1="http://schemas.datacontract.org/2004/07/StairBiz.Contracts.Dto.Controls">
    <d2p1:CheckBoxDto>
      <d2p1:Caption>sample string 4</d2p1:Caption>
      <d2p1:Checked>true</d2p1:Checked>
      <d2p1:Enabled>true</d2p1:Enabled>
      <d2p1:Visible>true</d2p1:Visible>
    </d2p1:CheckBoxDto>
    <d2p1:CheckBoxDto>
      <d2p1:Caption>sample string 4</d2p1:Caption>
      <d2p1:Checked>true</d2p1:Checked>
      <d2p1:Enabled>true</d2p1:Enabled>
      <d2p1:Visible>true</d2p1:Visible>
    </d2p1:CheckBoxDto>
  </Checkbox>
  <ContinueToWhichFunction>sample string 12</ContinueToWhichFunction>
  <Identifier>sample string 14</Identifier>
  <IsMacro>true</IsMacro>
  <MacroAlertMessage>sample string 13</MacroAlertMessage>
  <MacroName>sample string 3</MacroName>
  <ResponseType>Null</ResponseType>
  <ShowBuildersMarginAlert>true</ShowBuildersMarginAlert>
  <ShowDestinationError>true</ShowDestinationError>
  <ShowOverrideTruckAlert>true</ShowOverrideTruckAlert>
  <ShowTravelRequired>true</ShowTravelRequired>
  <ShowUpdateOrStandardAlert>true</ShowUpdateOrStandardAlert>
  <ShowVicAshAlert>true</ShowVicAshAlert>
  <ShowWrongStateAlert>true</ShowWrongStateAlert>
  <UpdatePricing>true</UpdatePricing>
  <Value>sample string 1</Value>
</NotificationResponseDto>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

NotificationResponseDto

Name	Type	Additional information
ResponseType	NotificationResponseEnum	None.
Value	string	None.
IsMacro	boolean	None.
MacroName	string	None.
Checkbox	Collection of CheckBoxDto	None.
ShowDestinationError	boolean	None.
ShowTravelRequired	boolean	None.
ShowOverrideTruckAlert	boolean	None.
ShowWrongStateAlert	boolean	None.
ShowVicAshAlert	boolean	None.
ShowBuildersMarginAlert	boolean	None.
ShowUpdateOrStandardAlert	boolean	None.
UpdatePricing	boolean	None.
ContinueToWhichFunction	string	None.
MacroAlertMessage	string	None.
Identifier	string	None.

Response Formats

application/json, text/json

Sample:

{
  "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:

<NotificationResponseDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/StairBiz.Contracts.Dto.Parameter">
  <Checkbox xmlns:d2p1="http://schemas.datacontract.org/2004/07/StairBiz.Contracts.Dto.Controls">
    <d2p1:CheckBoxDto>
      <d2p1:Caption>sample string 4</d2p1:Caption>
      <d2p1:Checked>true</d2p1:Checked>
      <d2p1:Enabled>true</d2p1:Enabled>
      <d2p1:Visible>true</d2p1:Visible>
    </d2p1:CheckBoxDto>
    <d2p1:CheckBoxDto>
      <d2p1:Caption>sample string 4</d2p1:Caption>
      <d2p1:Checked>true</d2p1:Checked>
      <d2p1:Enabled>true</d2p1:Enabled>
      <d2p1:Visible>true</d2p1:Visible>
    </d2p1:CheckBoxDto>
  </Checkbox>
  <ContinueToWhichFunction>sample string 12</ContinueToWhichFunction>
  <Identifier>sample string 14</Identifier>
  <IsMacro>true</IsMacro>
  <MacroAlertMessage>sample string 13</MacroAlertMessage>
  <MacroName>sample string 3</MacroName>
  <ResponseType>Null</ResponseType>
  <ShowBuildersMarginAlert>true</ShowBuildersMarginAlert>
  <ShowDestinationError>true</ShowDestinationError>
  <ShowOverrideTruckAlert>true</ShowOverrideTruckAlert>
  <ShowTravelRequired>true</ShowTravelRequired>
  <ShowUpdateOrStandardAlert>true</ShowUpdateOrStandardAlert>
  <ShowVicAshAlert>true</ShowVicAshAlert>
  <ShowWrongStateAlert>true</ShowWrongStateAlert>
  <UpdatePricing>true</UpdatePricing>
  <Value>sample string 1</Value>
</NotificationResponseDto>