POST api/PartSearch/PartSearch

Search for parts

Exceptions

ExceptionCondition
UnauthorizedHttpResponseException

Thrown if user is not subcontractor user, partner user or infocare user
ArgumentNullException

Thrown if invalid activity is specified, Invalid requisition type is specifed or
ArgumentMissingHttpResponseException

Thrown if search criteria is too short or values not set properly
ArgumentOutOfRangeHttpResponseException

Thrown if invalid values are used.

Request Information

URI Parameters

None.

Body Parameters

Specify search criteria

PartSearchArgumentModel
NameDescriptionTypeAdditional information
PartNumber

Get or set part number

 string

None.
PartName

Get or set part name/description

 string

None.
Brands

Limit search to a list of brands

 Collection of string

None.
Stocks

Limit search to a list of stocks.

 Collection of string

None.
Contracts

Limits the search to a list of contracts (stock contracts) To be used when Partners are searching against jeeves

 Collection of string

None.
RequisitionType

Gets or sets requisition type

 string

None.
CombinedActivityId

Gets or sets combined activity id

 string

None.
GetBundleContent

Gets or set search to get content of a bundle part

 boolean

None.
TicketId

Gets or sets the ticket id

 string

None.
Culture

Gets or sets culture, if not specified we will use culture set on user.

 string

None.

Request Formats

application/json, text/json

Sample: 
{
  "PartNumber": "sample string 1",
  "PartName": "sample string 2",
  "Brands": [
    "sample string 1",
    "sample string 2"
  ],
  "Stocks": [
    "sample string 1",
    "sample string 2"
  ],
  "Contracts": [
    "sample string 1",
    "sample string 2"
  ],
  "RequisitionType": "sample string 3",
  "CombinedActivityId": "sample string 4",
  "GetBundleContent": true,
  "TicketId": "sample string 6",
  "Culture": "sample string 7"
}

application/xml, text/xml

Sample: 
<PartSearchArgumentModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Rostov.Models">
  <Culture>sample string 7</Culture>
  <TicketId>sample string 6</TicketId>
  <Brands xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Brands>
  <CombinedActivityId>sample string 4</CombinedActivityId>
  <Contracts xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Contracts>
  <GetBundleContent>true</GetBundleContent>
  <PartName>sample string 2</PartName>
  <PartNumber>sample string 1</PartNumber>
  <RequisitionType>sample string 3</RequisitionType>
  <Stocks xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Stocks>
</PartSearchArgumentModel>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'PartSearchArgumentModel'.

Response Information

Resource Description

List of parts

PartSearchResultReturnModel
NameDescriptionTypeAdditional information
Parts

Gets or sets the return parts

 Collection of StockPartModel

None.
IsInCompleteSearch

The search is limited to getting at most 250 parts from each database you have access to. If there are more than 250 parts that should have been returned in the search this property will be set to true.

 boolean

None.
CombinedPerformanceId

Gets or sets the performance id. If performance monitoring is not turned on this property will not be present or set to null

 string

Json null value handling: Ignore

Response Formats

application/json, text/json

Sample: 
{
  "Parts": [
    {
      "StockId": "sample string 1",
      "CombinedStockId": "master:sample string 1",
      "CombinedStockPartId": "master:sample string 1:sample string 7",
      "StockName": "sample string 2",
      "TotalQuantity": 3,
      "SalesPrice": 4.0,
      "CostPrice": 5.0,
      "IsActive": true,
      "ConnectedStocks": [
        {
          "StockNo": "sample string 1",
          "StockName": "sample string 2",
          "Quantity": 3,
          "Priority": 4,
          "DisplayText": "sample string 5"
        },
        {
          "StockNo": "sample string 1",
          "StockName": "sample string 2",
          "Quantity": 3,
          "Priority": 4,
          "DisplayText": "sample string 5"
        }
      ],
      "DatabaseId": 0,
      "PartNumber": "sample string 7",
      "SubstitutePartNumber": "sample string 8",
      "EquivalentPartNumber": "sample string 9",
      "CombinedPartId": "master:sample string 7",
      "PartName": "sample string 10",
      "Brand": "sample string 11",
      "IsUsingSerialNumberHandling": true,
      "SerialNumberFormattingRules": [
        "sample string 1",
        "sample string 2"
      ],
      "IsReworkable": true,
      "QuantityOnLocalStock": 14,
      "QuantityOnCentralStock": 15,
      "IsBundled": true,
      "QuantityInBundle": 17,
      "BundleParts": [
        {
          "PartNumber": "sample string 1",
          "PartName": "sample string 2",
          "Quantity": 3.0
        },
        {
          "PartNumber": "sample string 1",
          "PartName": "sample string 2",
          "Quantity": 3.0
        }
      ]
    },
    {
      "StockId": "sample string 1",
      "CombinedStockId": "master:sample string 1",
      "CombinedStockPartId": "master:sample string 1:sample string 7",
      "StockName": "sample string 2",
      "TotalQuantity": 3,
      "SalesPrice": 4.0,
      "CostPrice": 5.0,
      "IsActive": true,
      "ConnectedStocks": [
        {
          "StockNo": "sample string 1",
          "StockName": "sample string 2",
          "Quantity": 3,
          "Priority": 4,
          "DisplayText": "sample string 5"
        },
        {
          "StockNo": "sample string 1",
          "StockName": "sample string 2",
          "Quantity": 3,
          "Priority": 4,
          "DisplayText": "sample string 5"
        }
      ],
      "DatabaseId": 0,
      "PartNumber": "sample string 7",
      "SubstitutePartNumber": "sample string 8",
      "EquivalentPartNumber": "sample string 9",
      "CombinedPartId": "master:sample string 7",
      "PartName": "sample string 10",
      "Brand": "sample string 11",
      "IsUsingSerialNumberHandling": true,
      "SerialNumberFormattingRules": [
        "sample string 1",
        "sample string 2"
      ],
      "IsReworkable": true,
      "QuantityOnLocalStock": 14,
      "QuantityOnCentralStock": 15,
      "IsBundled": true,
      "QuantityInBundle": 17,
      "BundleParts": [
        {
          "PartNumber": "sample string 1",
          "PartName": "sample string 2",
          "Quantity": 3.0
        },
        {
          "PartNumber": "sample string 1",
          "PartName": "sample string 2",
          "Quantity": 3.0
        }
      ]
    }
  ],
  "IsInCompleteSearch": true,
  "CombinedPerformanceId": "sample string 2"
}

application/xml, text/xml

Sample: 
<PartSearchResultReturnModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Rostov.Models">
  <CombinedPerformanceId>sample string 2</CombinedPerformanceId>
  <IsInCompleteSearch>true</IsInCompleteSearch>
  <Parts>
    <StockPartModel>
      <Brand>sample string 11</Brand>
      <BundleParts>
        <BundlePartModel>
          <PartName>sample string 2</PartName>
          <PartNumber>sample string 1</PartNumber>
          <Quantity>3</Quantity>
        </BundlePartModel>
        <BundlePartModel>
          <PartName>sample string 2</PartName>
          <PartNumber>sample string 1</PartNumber>
          <Quantity>3</Quantity>
        </BundlePartModel>
      </BundleParts>
      <IsBundled>true</IsBundled>
      <IsUsingSerialNumberHandling>true</IsUsingSerialNumberHandling>
      <PartName>sample string 10</PartName>
      <PartNumber>sample string 7</PartNumber>
      <QuantityInBundle>17</QuantityInBundle>
      <QuantityOnCentralStock>15</QuantityOnCentralStock>
      <QuantityOnLocalStock>14</QuantityOnLocalStock>
      <SerialNumberFormattingRules xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </SerialNumberFormattingRules>
      <IsActive>true</IsActive>
      <StockId>sample string 1</StockId>
      <StockName>sample string 2</StockName>
      <TotalQuantity>3</TotalQuantity>
    </StockPartModel>
    <StockPartModel>
      <Brand>sample string 11</Brand>
      <BundleParts>
        <BundlePartModel>
          <PartName>sample string 2</PartName>
          <PartNumber>sample string 1</PartNumber>
          <Quantity>3</Quantity>
        </BundlePartModel>
        <BundlePartModel>
          <PartName>sample string 2</PartName>
          <PartNumber>sample string 1</PartNumber>
          <Quantity>3</Quantity>
        </BundlePartModel>
      </BundleParts>
      <IsBundled>true</IsBundled>
      <IsUsingSerialNumberHandling>true</IsUsingSerialNumberHandling>
      <PartName>sample string 10</PartName>
      <PartNumber>sample string 7</PartNumber>
      <QuantityInBundle>17</QuantityInBundle>
      <QuantityOnCentralStock>15</QuantityOnCentralStock>
      <QuantityOnLocalStock>14</QuantityOnLocalStock>
      <SerialNumberFormattingRules xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </SerialNumberFormattingRules>
      <IsActive>true</IsActive>
      <StockId>sample string 1</StockId>
      <StockName>sample string 2</StockName>
      <TotalQuantity>3</TotalQuantity>
    </StockPartModel>
  </Parts>
</PartSearchResultReturnModel>