POST api/ItemCatalogFmt1/Delete

Add Catalog Item

Request Information

URI Parameters

None.

Body Parameters

Catalog Item

Name	Description	Type	Additional information
ClientId	ClientId	integer	None.
CompanyCode	Company Code: 50 Character Limit	string	None.
CompanyId		integer	None.
ItemNumber	Item Number: 20 Characters Limit	string	None.
ItemName	Item Name: 60 Character Limit	string	None.
ItemGroup	Item Group: 40 Character Limit	string	None.
Price	Item Price	decimal number	None.
PreferredVendor	Preferred Vendor: 50 Character Limit	string	None.
GLCode	Item GL Code: 6 Character Limit	string	None.
Description	Item Description: 1,000 Character Limit	string	None.
CostCenter	Cost Center: 50 Character Limit	string	None.
UnitOfMeasure	Item Unit of Measure: 50 Character Limit	string	None.
OnHold	On Hold: "All" or "No"	string	None.

Request Formats

application/json, text/json

Sample:

{
  "ClientId": 1,
  "CompanyCode": "sample string 2",
  "CompanyId": 3,
  "ItemNumber": "sample string 4",
  "ItemName": "sample string 5",
  "ItemGroup": "sample string 6",
  "Price": 7.0,
  "PreferredVendor": "sample string 8",
  "GLCode": "sample string 9",
  "Description": "sample string 10",
  "CostCenter": "sample string 11",
  "UnitOfMeasure": "sample string 12",
  "OnHold": "sample string 13"
}

application/xml, text/xml

Sample:

<ItemCatalogFmt1Controller.CatalogItem xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NextProcess.Web.API.Controllers">
  <ClientId>1</ClientId>
  <CompanyCode>sample string 2</CompanyCode>
  <CompanyId>3</CompanyId>
  <CostCenter>sample string 11</CostCenter>
  <Description>sample string 10</Description>
  <GLCode>sample string 9</GLCode>
  <ItemGroup>sample string 6</ItemGroup>
  <ItemName>sample string 5</ItemName>
  <ItemNumber>sample string 4</ItemNumber>
  <OnHold>sample string 13</OnHold>
  <PreferredVendor>sample string 8</PreferredVendor>
  <Price>7</Price>
  <UnitOfMeasure>sample string 12</UnitOfMeasure>
</ItemCatalogFmt1Controller.CatalogItem>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Processing results

APIResult

Name	Description	Type	Additional information
IsValid	API call result	boolean	None.
Comments	Comments about the activities of the API call	string	None.
Errors	List of 0 to many errors encountered processing the API call	Collection of ErrorMessage	None.

Response Formats

application/json, text/json

Sample:

{
  "IsValid": true,
  "Comments": "sample string 2",
  "Errors": [
    {
      "Message": "sample string 1"
    },
    {
      "Message": "sample string 1"
    }
  ]
}

application/xml, text/xml

Sample:

<APIResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NextProcess.Web.API.Controllers.Util">
  <Comments>sample string 2</Comments>
  <Errors>
    <APIResult.ErrorMessage>
      <Message>sample string 1</Message>
    </APIResult.ErrorMessage>
    <APIResult.ErrorMessage>
      <Message>sample string 1</Message>
    </APIResult.ErrorMessage>
  </Errors>
  <IsValid>true</IsValid>
</APIResult>