POST Item/id/build

Build a quantity of a combo item.

Request Information

URI Parameters

Name	Description	Type	Additional information
WsAccessKey	The Web Service access key for this user and file which allows access to the API for the associated file (found in File - Settings). Using OAuth authentication mechanism is the preferred method to allow API access.	string	Optional. Legacy authentication method and only required if not using OAuth. OAuth is preferred.
FileId	Specifies the file id of the file to perform the operation upon.	integer	Required
id	Item Id	integer	Required

Body Parameters

Build details.

BuildComboItem

Name	Description	Type	Additional information
Quantity	The quantity to build.	decimal number	None.

Request Formats

application/json, text/json

Sample:

{
  "Quantity": 1.0
}

application/xml, text/xml

Sample:

<BuildComboItem xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Quantity>1</Quantity>
</BuildComboItem>

Response Information

Resource Description

BuildItemResult

Name	Description	Type	Additional information
ItemId	The id of the built item.	integer	None.
StatusMessage	Status message from the response (if any).	string	None.
_links	Hypermedia links. Contains contextual links to possible next actions related to this resource. Only present in responses. This data is not to be sent to the server.	Collection of Link	None.

Response Formats

application/json, text/json

Sample:

{
  "ItemId": 123,
  "StatusMessage": "1 combo item(s) have been built.",
  "_links": [
    {
      "rel": "detail",
      "href": "https://api.saasu.com/Item/123?FileId=1234",
      "method": "GET",
      "title": null
    },
    {
      "rel": "self",
      "href": "https://api.saasu.com/Item/123/build/?FileId=1234",
      "method": "GET",
      "title": null
    }
  ]
}

application/xml, text/xml

Sample:

<BuildItemResult xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <_links>
    <Link>
      <rel>detail</rel>
      <href>https://api.saasu.com/Item/123?FileId=1234</href>
      <method>GET</method>
    </Link>
    <Link>
      <rel>self</rel>
      <href>https://api.saasu.com/Item/123/build/?FileId=1234</href>
      <method>GET</method>
    </Link>
  </_links>
  <StatusMessage>1 combo item(s) have been built.</StatusMessage>
  <ItemId>123</ItemId>
</BuildItemResult>