POST api/article/ArticlesWithSubstitutions?isGMDealer={isGMDealer}&prioritizeStockedDE={prioritizeStockedDE}&prioritizeStockedSE={prioritizeStockedSE}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
isGMDealer

boolean

Required

prioritizeStockedDE

boolean

Default value is False

prioritizeStockedSE

boolean

Default value is False

Body Parameters

Collection of string

Request Formats

application/json, text/json

Sample:
[
  "sample string 1",
  "sample string 2"
]

application/xml, text/xml

Sample:
<ArrayOfstring xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
  <string>sample string 1</string>
  <string>sample string 2</string>
</ArrayOfstring>

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 'String[]'.

Response Information

Resource Description

Collection of BlackBoxArticle
NameDescriptionTypeAdditional information
Article

Article

None.

PartData

PartData

None.

SubstitutionArticles

Collection of BlackBoxArticleSubstitution

None.

Found

boolean

None.

ItemNo

string

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "Article": null,
    "PartData": {
      "PartId": "sample string 1",
      "ArticleNumber": "sample string 2",
      "HeaderPrefix": "sample string 3",
      "Prefix": "sample string 4",
      "ActivantUrl": "sample string 5",
      "Label": "sample string 6",
      "Remarks": [
        "sample string 1",
        "sample string 2"
      ],
      "Quantity": "sample string 7",
      "ExtendedDescription": "sample string 8",
      "Years": "sample string 9",
      "UnAnsweredSpecId": "sample string 10"
    },
    "SubstitutionArticles": [
      {
        "SubstituteTo": "sample string 1",
        "TypeOfSubstitute": 2,
        "Article": null
      },
      {
        "SubstituteTo": "sample string 1",
        "TypeOfSubstitute": 2,
        "Article": null
      }
    ],
    "Found": true,
    "ItemNo": "sample string 2"
  },
  {
    "Article": null,
    "PartData": {
      "PartId": "sample string 1",
      "ArticleNumber": "sample string 2",
      "HeaderPrefix": "sample string 3",
      "Prefix": "sample string 4",
      "ActivantUrl": "sample string 5",
      "Label": "sample string 6",
      "Remarks": [
        "sample string 1",
        "sample string 2"
      ],
      "Quantity": "sample string 7",
      "ExtendedDescription": "sample string 8",
      "Years": "sample string 9",
      "UnAnsweredSpecId": "sample string 10"
    },
    "SubstitutionArticles": [
      {
        "SubstituteTo": "sample string 1",
        "TypeOfSubstitute": 2,
        "Article": null
      },
      {
        "SubstituteTo": "sample string 1",
        "TypeOfSubstitute": 2,
        "Article": null
      }
    ],
    "Found": true,
    "ItemNo": "sample string 2"
  }
]

application/xml

Sample:

An exception has occurred while using the formatter 'XmlMediaTypeFormatter' to generate sample for media type 'application/xml'. Exception message: Type 'KWParts.Elastic.Document.Article' cannot be serialized. Consider marking it with the DataContractAttribute attribute, and marking all of its members you want serialized with the DataMemberAttribute attribute. If the type is a collection, consider marking it with the CollectionDataContractAttribute. See the Microsoft .NET Framework documentation for other supported types.

text/xml

Sample:

An exception has occurred while using the formatter 'XmlMediaTypeFormatter' to generate sample for media type 'text/xml'. Exception message: Type 'KWParts.Elastic.Document.Article' cannot be serialized. Consider marking it with the DataContractAttribute attribute, and marking all of its members you want serialized with the DataMemberAttribute attribute. If the type is a collection, consider marking it with the CollectionDataContractAttribute. See the Microsoft .NET Framework documentation for other supported types.