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

Request Information

URI Parameters

Name	Description	Type	Additional information
siteId		globally unique identifier	None.

Body Parameters

ItemSegmentViewModel

Name	Type	Additional information
descriptions	Dictionary of string [key] and string [value]	None.
id	globally unique identifier	None.
code	integer	Required
technical_description	string	Required String length: inclusive between 0 and 100
active	boolean	Required

Request Formats

application/json, text/json

Sample:

{
  "descriptions": {
    "sample string 1": "sample string 2",
    "sample string 3": "sample string 4"
  },
  "id": "c50a23f7-a8fc-4dd1-b503-460b4555c20d",
  "code": 2,
  "technical_description": "sample string 3",
  "active": true
}

application/xml, text/xml

Sample:

<itemsegment xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EntityModel">
  <active>true</active>
  <code>2</code>
  <id>c50a23f7-a8fc-4dd1-b503-460b4555c20d</id>
  <technical_description>sample string 3</technical_description>
  <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>
  </descriptions>
</itemsegment>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

globally unique identifier

Response Formats

application/json, text/json

Sample:

"1754fa43-ad28-4d77-9ea7-bd5008d58292"

application/xml, text/xml

Sample:

<guid xmlns="http://schemas.microsoft.com/2003/10/Serialization/">1754fa43-ad28-4d77-9ea7-bd5008d58292</guid>