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

Request Information

URI Parameters

NameDescriptionTypeAdditional information
siteId

globally unique identifier

None.

Body Parameters

DepartmentItemViewModel
NameDescriptionTypeAdditional information
item_code

string

None.

item_descriptions

Dictionary of string [key] and string [value]

None.

selected_sticker_id

globally unique identifier

None.

selected_nameplate_id

globally unique identifier

None.

active

boolean

Required

department_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_code": "sample string 1",
  "item_descriptions": {
    "sample string 1": "sample string 2",
    "sample string 3": "sample string 4"
  },
  "selected_sticker_id": "456c92fe-7b76-4520-a296-1a35e7c1e7e7",
  "selected_nameplate_id": "face657a-3475-436f-813b-8b7850da98c0",
  "active": true,
  "department_id": "e4942f47-b513-405b-a581-4859281365eb",
  "id": "67bc4e2e-8797-4300-833e-d5ddd12edeb3",
  "physical_item_id": "4792fc69-3030-4c1a-a4e0-758daafc5adf",
  "service_item_id": "f3a00ef9-4fae-4636-9c53-d611ec3833a1",
  "item_wash_max": 1,
  "quantity": 1
}

application/xml, text/xml

Sample:
<department_item xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EntityModel">
  <active>true</active>
  <department_id>e4942f47-b513-405b-a581-4859281365eb</department_id>
  <id>67bc4e2e-8797-4300-833e-d5ddd12edeb3</id>
  <item_wash_max>1</item_wash_max>
  <physical_item_id>4792fc69-3030-4c1a-a4e0-758daafc5adf</physical_item_id>
  <quantity>1</quantity>
  <service_item_id>f3a00ef9-4fae-4636-9c53-d611ec3833a1</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>face657a-3475-436f-813b-8b7850da98c0</selected_nameplate_id>
  <selected_sticker_id>456c92fe-7b76-4520-a296-1a35e7c1e7e7</selected_sticker_id>
</department_item>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

globally unique identifier

Response Formats

application/json, text/json

Sample:
"0c7f0c56-930c-4dd4-a304-496ee5811d62"

application/xml, text/xml

Sample:
<guid xmlns="http://schemas.microsoft.com/2003/10/Serialization/">0c7f0c56-930c-4dd4-a304-496ee5811d62</guid>