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": "4883554a-4b09-40f6-b7c9-a5dd2acd823f",
  "selected_nameplate_id": "772251a8-01d7-401d-b513-c1e14fc50b41",
  "active": true,
  "department_id": "3edac34c-3b26-4d5e-95e1-6448a7c9d941",
  "id": "733f17b7-0aa5-416b-97ff-4f975042614b",
  "physical_item_id": "bd095278-f6b8-40f9-9cc5-f39d7d1dce76",
  "service_item_id": "450c568a-67ed-47ff-a5de-c0010a840aef",
  "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>3edac34c-3b26-4d5e-95e1-6448a7c9d941</department_id>
  <id>733f17b7-0aa5-416b-97ff-4f975042614b</id>
  <item_wash_max>1</item_wash_max>
  <physical_item_id>bd095278-f6b8-40f9-9cc5-f39d7d1dce76</physical_item_id>
  <quantity>1</quantity>
  <service_item_id>450c568a-67ed-47ff-a5de-c0010a840aef</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>772251a8-01d7-401d-b513-c1e14fc50b41</selected_nameplate_id>
  <selected_sticker_id>4883554a-4b09-40f6-b7c9-a5dd2acd823f</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:
"a4ab81ab-b5fd-4cf8-a60c-45ae90781b82"

application/xml, text/xml

Sample:
<guid xmlns="http://schemas.microsoft.com/2003/10/Serialization/">a4ab81ab-b5fd-4cf8-a60c-45ae90781b82</guid>