POST api/ApiIntegration/SBGetPartFilterInfo

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
PrivateApiKey	string	None.
JobKeyList	Collection of globally unique identifier	None.
IncludeProcessWindow	boolean	None.
IncludeClientWindow	boolean	None.
IncludeContactWindow	boolean	None.
IncludeSiteWindow	boolean	None.
IncludeDetailWindow	boolean	None.
IncludeComponentsWindow	boolean	None.
IncludeSetupWindow	boolean	None.
IncludeDesignWindow	boolean	None.
IncludeQuoteWindow	boolean	None.
IncludeMyDataValues	boolean	None.
IncludeHistory	boolean	None.
IncludeNotes	boolean	None.
IncludeCuttingList	boolean	None.
IncludeBOM	boolean	None.
IncludeLaborList	boolean	None.
IncludeShortcuts	boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "privateApiKey": "sample string 1",
  "jobKeyList": [
    "4a6172c9-4fe0-495c-92f6-bd95d31591ee",
    "64abc99f-ed4d-49e0-a3b5-c5d7d44e9d2a"
  ],
  "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:

<ApiJobInfoViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/StairBiz.Contracts.ViewModels">
  <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:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:guid>4a6172c9-4fe0-495c-92f6-bd95d31591ee</d2p1:guid>
    <d2p1:guid>64abc99f-ed4d-49e0-a3b5-c5d7d44e9d2a</d2p1:guid>
  </JobKeyList>
  <PrivateApiKey>sample string 1</PrivateApiKey>
</ApiJobInfoViewModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Collection of ApiFilterDataInfo

Name	Type	Additional information
ProjectName	string	None.
JobNumber	string	None.
QuoteNumber	string	None.
CreatedBy	string	None.
CreatedDAte	string	None.
IsSameBalustradePartFilter	boolean	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "projectName": "sample string 1",
    "jobNumber": "sample string 2",
    "quoteNumber": "sample string 3",
    "createdBy": "sample string 4",
    "createdDAte": "sample string 5",
    "isSameBalustradePartFilter": true
  },
  {
    "projectName": "sample string 1",
    "jobNumber": "sample string 2",
    "quoteNumber": "sample string 3",
    "createdBy": "sample string 4",
    "createdDAte": "sample string 5",
    "isSameBalustradePartFilter": true
  }
]

application/xml, text/xml

Sample:

<ArrayOfApiFilterDataInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/StairBiz.Contracts.ViewModels">
  <ApiFilterDataInfo>
    <CreatedBy>sample string 4</CreatedBy>
    <CreatedDAte>sample string 5</CreatedDAte>
    <IsSameBalustradePartFilter>true</IsSameBalustradePartFilter>
    <JobNumber>sample string 2</JobNumber>
    <ProjectName>sample string 1</ProjectName>
    <QuoteNumber>sample string 3</QuoteNumber>
  </ApiFilterDataInfo>
  <ApiFilterDataInfo>
    <CreatedBy>sample string 4</CreatedBy>
    <CreatedDAte>sample string 5</CreatedDAte>
    <IsSameBalustradePartFilter>true</IsSameBalustradePartFilter>
    <JobNumber>sample string 2</JobNumber>
    <ProjectName>sample string 1</ProjectName>
    <QuoteNumber>sample string 3</QuoteNumber>
  </ApiFilterDataInfo>
</ArrayOfApiFilterDataInfo>