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

Request Information

URI Parameters

NameDescriptionTypeAdditional information
siteId

globally unique identifier

None.

Body Parameters

ContractItemViewModel
NameDescriptionTypeAdditional 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": "2cf67d3c-e817-462b-9f9b-560aa6864ea8",
  "selected_nameplate_id": "241da34c-f540-41aa-b02c-aabc11c73ee5",
  "active": true,
  "contract_id": "a8477903-4346-400b-8410-21f56440ff07",
  "id": "8d590e18-9141-4c61-ada9-35f28e1aa70a",
  "physical_item_id": "ccec96b6-eb9d-4435-a4a3-4cfb776e5688",
  "service_item_id": "32f1211e-24d5-4945-a3e7-1fa86c21e1ad",
  "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>a8477903-4346-400b-8410-21f56440ff07</contract_id>
  <id>8d590e18-9141-4c61-ada9-35f28e1aa70a</id>
  <item_wash_max>1</item_wash_max>
  <physical_item_id>ccec96b6-eb9d-4435-a4a3-4cfb776e5688</physical_item_id>
  <quantity>1</quantity>
  <service_item_id>32f1211e-24d5-4945-a3e7-1fa86c21e1ad</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>241da34c-f540-41aa-b02c-aabc11c73ee5</selected_nameplate_id>
  <selected_sticker_id>2cf67d3c-e817-462b-9f9b-560aa6864ea8</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:
"537aeff8-6616-488f-a80d-00625109d493"

application/xml, text/xml

Sample:
<guid xmlns="http://schemas.microsoft.com/2003/10/Serialization/">537aeff8-6616-488f-a80d-00625109d493</guid>