POST api/contractItemapi/add?siteId={siteId}

Request Information

URI Parameters

Name	Description	Type	Additional information
siteId		globally unique identifier	None.

Body Parameters

ContractItemViewModel

Name	Type	Additional information
item_descriptions	Dictionary of string [key] and string [value]	None.
item_code	string	None.
selected_sticker_id	globally unique identifier	None.
selected_nameplate_id	globally unique identifier	None.
active	boolean	Required
contract_id	globally unique identifier	Required
id	globally unique identifier	None.
physical_item_id	globally unique identifier	None.
service_item_id	globally unique identifier	None.
item_wash_max	integer	None.
quantity	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "item_descriptions": {
    "sample string 1": "sample string 2",
    "sample string 3": "sample string 4"
  },
  "item_code": "sample string 1",
  "selected_sticker_id": "6e589c0a-e5f8-4311-a76f-038dadf7c5e8",
  "selected_nameplate_id": "3fd3fdc0-ea26-41e8-8cd5-a78d06847580",
  "active": true,
  "contract_id": "e6d3094b-fbf6-4fc6-8915-f22b7ba62498",
  "id": "1c21be1a-1064-4b00-bc72-08babba4e931",
  "physical_item_id": "0fc06184-608d-4936-bacb-56062d7ea93d",
  "service_item_id": "b2f11dad-6465-4606-93a8-b6292f4636d3",
  "item_wash_max": 1,
  "quantity": 1
}

application/xml, text/xml

Sample:

<contract_item xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EntityModel">
  <active>true</active>
  <contract_id>e6d3094b-fbf6-4fc6-8915-f22b7ba62498</contract_id>
  <id>1c21be1a-1064-4b00-bc72-08babba4e931</id>
  <item_wash_max>1</item_wash_max>
  <physical_item_id>0fc06184-608d-4936-bacb-56062d7ea93d</physical_item_id>
  <quantity>1</quantity>
  <service_item_id>b2f11dad-6465-4606-93a8-b6292f4636d3</service_item_id>
  <item_code>sample string 1</item_code>
  <item_descriptions xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>sample string 1</d2p1:Key>
      <d2p1:Value>sample string 2</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>sample string 3</d2p1:Key>
      <d2p1:Value>sample string 4</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </item_descriptions>
  <selected_nameplate_id>3fd3fdc0-ea26-41e8-8cd5-a78d06847580</selected_nameplate_id>
  <selected_sticker_id>6e589c0a-e5f8-4311-a76f-038dadf7c5e8</selected_sticker_id>
</contract_item>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

globally unique identifier

Response Formats

application/json, text/json

Sample:

"02bcfbae-83a4-4e12-92cd-1c6699672520"

application/xml, text/xml

Sample:

<guid xmlns="http://schemas.microsoft.com/2003/10/Serialization/">02bcfbae-83a4-4e12-92cd-1c6699672520</guid>