POST api/Item

Request Information

URI Parameters

None.

Body Parameters

Item
NameDescriptionTypeAdditional information
ItemId

The unique id for the item

integer

None.

ListId

The unique id of the the item belongs to

integer

None.

Title

A title to display as a summary

string

None.

Description

Detailed description

string

None.

Active

True if the item is active (equivalent of not deleted)

boolean

None.

CustomFields

The custom fields that belong to this

Collection of CustomField

None.

Request Formats

application/json, text/json

Sample:
{
  "itemId": 1,
  "listId": 2,
  "title": "sample string 3",
  "description": "sample string 4",
  "active": true,
  "customFields": [
    {
      "customFieldId": 1,
      "listId": 2,
      "itemId": 3,
      "title": "sample string 4",
      "value": "sample string 5"
    },
    {
      "customFieldId": 1,
      "listId": 2,
      "itemId": 3,
      "title": "sample string 4",
      "value": "sample string 5"
    }
  ]
}

application/xml, text/xml

Sample:
<Item xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TScunts.Models.API.List">
  <Active>true</Active>
  <CustomFields>
    <CustomField>
      <CustomFieldId>1</CustomFieldId>
      <ItemId>3</ItemId>
      <ListId>2</ListId>
      <Title>sample string 4</Title>
      <Value>sample string 5</Value>
    </CustomField>
    <CustomField>
      <CustomFieldId>1</CustomFieldId>
      <ItemId>3</ItemId>
      <ListId>2</ListId>
      <Title>sample string 4</Title>
      <Value>sample string 5</Value>
    </CustomField>
  </CustomFields>
  <Description>sample string 4</Description>
  <ItemId>1</ItemId>
  <ListId>2</ListId>
  <Title>sample string 3</Title>
</Item>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

GenericResourceResponse
NameDescriptionTypeAdditional information
Id

The unique id of the resource that is worked with

integer

None.

Success

True if successful

boolean

None.

ErrorMessage

Error message if the request is unsuccessful

string

None.

Response Formats

application/json, text/json

Sample:
{
  "id": 1,
  "success": true,
  "errorMessage": "sample string 3"
}

application/xml, text/xml

Sample:
<GenericResourceResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TScunts.Models.API.List">
  <ErrorMessage>sample string 3</ErrorMessage>
  <Id>1</Id>
  <Success>true</Success>
</GenericResourceResponse>