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": "1a0866d6-1ab7-4e67-b9b4-a7cdefca728e",
  "selected_nameplate_id": "621a16b8-573e-4e09-8caa-748d7777e43f",
  "active": true,
  "contract_id": "e9cc653e-a2dd-483b-8244-2734750bcea9",
  "id": "598a7d16-cb19-4b8b-ac92-19a9bfdedaed",
  "physical_item_id": "25a0d428-3a80-41a0-997e-2732a43d9892",
  "service_item_id": "e176ff7c-ceb0-4a4e-b808-9b5646b61eaf",
  "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>e9cc653e-a2dd-483b-8244-2734750bcea9</contract_id>
  <id>598a7d16-cb19-4b8b-ac92-19a9bfdedaed</id>
  <item_wash_max>1</item_wash_max>
  <physical_item_id>25a0d428-3a80-41a0-997e-2732a43d9892</physical_item_id>
  <quantity>1</quantity>
  <service_item_id>e176ff7c-ceb0-4a4e-b808-9b5646b61eaf</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>621a16b8-573e-4e09-8caa-748d7777e43f</selected_nameplate_id>
  <selected_sticker_id>1a0866d6-1ab7-4e67-b9b4-a7cdefca728e</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:

"54a7bb24-96fa-4f7b-9c06-4200380cfef2"

application/xml, text/xml

Sample:

<guid xmlns="http://schemas.microsoft.com/2003/10/Serialization/">54a7bb24-96fa-4f7b-9c06-4200380cfef2</guid>