POST api/ApiIntegration/SBSetInventoryActive

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
PrivateApiKey	string	None.
JobNumberOrQuoteNumberList	Collection of string	None.
IncludeList	ApiJobInfoViewModel	None.

Request Formats

application/json, text/json

Sample:

{
  "privateApiKey": "sample string 1",
  "jobNumberOrQuoteNumberList": [
    "sample string 1",
    "sample string 2"
  ],
  "includeList": {
    "privateApiKey": "sample string 1",
    "jobKeyList": [
      "b0853dcf-511e-4f89-a0e5-6268c2fc5b0f",
      "057c526b-8a49-4f7e-a794-b09294de6328"
    ],
    "includeProcessWindow": true,
    "includeClientWindow": true,
    "includeContactWindow": true,
    "includeSiteWindow": true,
    "includeDetailWindow": true,
    "includeComponentsWindow": true,
    "includeSetupWindow": true,
    "includeDesignWindow": true,
    "includeQuoteWindow": true,
    "includeMyDataValues": true,
    "includeHistory": true,
    "includeNotes": true,
    "includeCuttingList": true,
    "includeBOM": true,
    "includeLaborList": true,
    "includeShortcuts": true
  }
}

application/xml, text/xml

Sample:

<ApiJobsByJobNumberParam xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/StairBiz.Contracts.ViewModels">
  <IncludeList>
    <IncludeBOM>true</IncludeBOM>
    <IncludeClientWindow>true</IncludeClientWindow>
    <IncludeComponentsWindow>true</IncludeComponentsWindow>
    <IncludeContactWindow>true</IncludeContactWindow>
    <IncludeCuttingList>true</IncludeCuttingList>
    <IncludeDesignWindow>true</IncludeDesignWindow>
    <IncludeDetailWindow>true</IncludeDetailWindow>
    <IncludeHistory>true</IncludeHistory>
    <IncludeLaborList>true</IncludeLaborList>
    <IncludeMyDataValues>true</IncludeMyDataValues>
    <IncludeNotes>true</IncludeNotes>
    <IncludeProcessWindow>true</IncludeProcessWindow>
    <IncludeQuoteWindow>true</IncludeQuoteWindow>
    <IncludeSetupWindow>true</IncludeSetupWindow>
    <IncludeShortcuts>true</IncludeShortcuts>
    <IncludeSiteWindow>true</IncludeSiteWindow>
    <JobKeyList xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:guid>b0853dcf-511e-4f89-a0e5-6268c2fc5b0f</d3p1:guid>
      <d3p1:guid>057c526b-8a49-4f7e-a794-b09294de6328</d3p1:guid>
    </JobKeyList>
    <PrivateApiKey>sample string 1</PrivateApiKey>
  </IncludeList>
  <JobNumberOrQuoteNumberList xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </JobNumberOrQuoteNumberList>
  <PrivateApiKey>sample string 1</PrivateApiKey>
</ApiJobsByJobNumberParam>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Collection of ApiInventoryInfo

Name	Type	Additional information
Type	integer	None.
LooseType	integer	None.
Category	integer	None.
StyleName	string	None.
Timber	string	None.
Description	string	None.
Width	integer	None.
Depth	integer	None.
Quantity	integer	None.
Length	integer	None.
Cost	decimal number	None.
UomIsEach	boolean	None.
Tag	integer	None.
TotalCost	decimal number	None.
Waste	integer	None.
Widthraw	integer	None.
InventoryNote	integer	None.
JobKey	globally unique identifier	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "type": 1,
    "looseType": 1,
    "category": 1,
    "styleName": "sample string 1",
    "timber": "sample string 2",
    "description": "sample string 3",
    "width": 1,
    "depth": 1,
    "quantity": 1,
    "length": 1,
    "cost": 1.0,
    "uomIsEach": true,
    "tag": 1,
    "totalCost": 1.0,
    "waste": 1,
    "widthraw": 1,
    "inventoryNote": 1,
    "jobKey": "949e9d39-2879-4326-a0c8-9d38b33838b1"
  },
  {
    "type": 1,
    "looseType": 1,
    "category": 1,
    "styleName": "sample string 1",
    "timber": "sample string 2",
    "description": "sample string 3",
    "width": 1,
    "depth": 1,
    "quantity": 1,
    "length": 1,
    "cost": 1.0,
    "uomIsEach": true,
    "tag": 1,
    "totalCost": 1.0,
    "waste": 1,
    "widthraw": 1,
    "inventoryNote": 1,
    "jobKey": "949e9d39-2879-4326-a0c8-9d38b33838b1"
  }
]

application/xml, text/xml

Sample:

<ArrayOfApiInventoryInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/StairBiz.Contracts.ViewModels">
  <ApiInventoryInfo>
    <Category>1</Category>
    <Cost>1</Cost>
    <Depth>1</Depth>
    <Description>sample string 3</Description>
    <InventoryNote>1</InventoryNote>
    <JobKey>949e9d39-2879-4326-a0c8-9d38b33838b1</JobKey>
    <Length>1</Length>
    <LooseType>1</LooseType>
    <Quantity>1</Quantity>
    <StyleName>sample string 1</StyleName>
    <Tag>1</Tag>
    <Timber>sample string 2</Timber>
    <TotalCost>1</TotalCost>
    <Type>1</Type>
    <UomIsEach>true</UomIsEach>
    <Waste>1</Waste>
    <Width>1</Width>
    <Widthraw>1</Widthraw>
  </ApiInventoryInfo>
  <ApiInventoryInfo>
    <Category>1</Category>
    <Cost>1</Cost>
    <Depth>1</Depth>
    <Description>sample string 3</Description>
    <InventoryNote>1</InventoryNote>
    <JobKey>949e9d39-2879-4326-a0c8-9d38b33838b1</JobKey>
    <Length>1</Length>
    <LooseType>1</LooseType>
    <Quantity>1</Quantity>
    <StyleName>sample string 1</StyleName>
    <Tag>1</Tag>
    <Timber>sample string 2</Timber>
    <TotalCost>1</TotalCost>
    <Type>1</Type>
    <UomIsEach>true</UomIsEach>
    <Waste>1</Waste>
    <Width>1</Width>
    <Widthraw>1</Widthraw>
  </ApiInventoryInfo>
</ArrayOfApiInventoryInfo>