POST api/Items/Get

Request Information

URI Parameters

None.

Body Parameters

ItemInfo

Name	Description	Type	Additional information
tkn		string	Required String length: inclusive between 1 and 50
ItemGUID		string	Required String length: inclusive between 5 and 100

Name

Description

Type

Additional information

tkn

string

Required

String length: inclusive between 1 and 50

ItemGUID

string

Required

String length: inclusive between 5 and 100

Request Formats

application/json, text/json

Sample:

{
  "tkn": "sample string 1",
  "ItemGUID": "sample string 2"
}

application/octet-stream

Sample:

{"tkn":"sample string 1","ItemGUID":"sample string 2"}

application/xml, text/xml

Sample:

<ItemInfo xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <tkn>sample string 1</tkn>
  <ItemGUID>sample string 2</ItemGUID>
</ItemInfo>

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 'ItemInfo'.

Response Information

Resource Description

ItemsEntity

Name	Type	Additional information
Name	string	None.
ItemTypeGUID	string	None.
TagUID	string	None.
Cost	decimal number	None.
Price	decimal number	None.
isInventory	boolean	None.
QuantityOnHand	decimal number	None.
ExternalID	string	None.
Values	Collection of Field	None.

Response Formats

application/json, text/json

Sample:

{
  "Name": "sample string 1",
  "ItemTypeGUID": "sample string 2",
  "TagUID": "sample string 3",
  "Cost": 4.1,
  "Price": 5.1,
  "isInventory": true,
  "QuantityOnHand": 7.1,
  "ExternalID": "sample string 8",
  "Values": [
    {
      "apiId": "sample string 1",
      "Value": {},
      "ExternalID": "sample string 3"
    },
    {
      "apiId": "sample string 1",
      "Value": {},
      "ExternalID": "sample string 3"
    }
  ]
}

application/octet-stream

Sample:

{"Name":"sample string 1","ItemTypeGUID":"sample string 2","TagUID":"sample string 3","Cost":4.1,"Price":5.1,"isInventory":true,"QuantityOnHand":7.1,"ExternalID":"sample string 8","Values":[{"apiId":"sample string 1","Value":{},"ExternalID":"sample string 3"},{"apiId":"sample string 1","Value":{},"ExternalID":"sample string 3"}]}

application/xml, text/xml

Sample:

<ItemsEntity xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Name>sample string 1</Name>
  <ItemTypeGUID>sample string 2</ItemTypeGUID>
  <TagUID>sample string 3</TagUID>
  <Cost>4.1</Cost>
  <Price>5.1</Price>
  <isInventory>true</isInventory>
  <QuantityOnHand>7.1</QuantityOnHand>
  <ExternalID>sample string 8</ExternalID>
  <Values>
    <Field>
      <apiId>sample string 1</apiId>
      <Value />
      <ExternalID>sample string 3</ExternalID>
    </Field>
    <Field>
      <apiId>sample string 1</apiId>
      <Value />
      <ExternalID>sample string 3</ExternalID>
    </Field>
  </Values>
</ItemsEntity>