POST api/v2/classes
Create new item class
Request Information
URI Parameters
None.
Body Parameters
ClassPost| Name | Description | Type | Additional information |
|---|---|---|---|
| parent-class |
Parent class details |
ClassSimple |
None. |
| name |
Class name |
string |
Required |
| description |
Class description |
string |
None. |
| icon-uri |
Location URI of the class icon |
string |
None. |
| image-uri |
Location URI of the class image |
string |
None. |
| status |
Status (active or not) |
TagvueEntityStatus |
None. |
| entity-id |
Identifying entity-id of the entity, this is expected to be unique |
string |
None. |
Request Formats
application/xml, text/xml
Sample:
<item-class entity-id="sample string 5" xmlns="urn:tagvue:am">
<status>inactive</status>
<parent-class entity-id="sample string 2">
<name>sample string 1</name>
</parent-class>
<name>sample string 1</name>
<description>sample string 2</description>
<icon-uri>sample string 3</icon-uri>
<image-uri>sample string 4</image-uri>
</item-class>
application/json, text/json
Sample:
{
"parent-class": {
"name": "sample string 1",
"entity-id": "sample string 2"
},
"name": "sample string 1",
"description": "sample string 2",
"icon-uri": "sample string 3",
"image-uri": "sample string 4",
"status": 0,
"entity-id": "sample string 5"
}
Response Information
Resource Description
Returns CREATED (201) if operation was succesfull or BAD REQUEST (400) if received object is invalid
HttpResponseMessage| Name | Description | Type | Additional information |
|---|---|---|---|
| Version | Version |
None. |
|
| Content | HttpContent |
None. |
|
| StatusCode | HttpStatusCode |
None. |
|
| ReasonPhrase | string |
None. |
|
| Headers | Collection of Object |
None. |
|
| RequestMessage | HttpRequestMessage |
None. |
|
| IsSuccessStatusCode | boolean |
None. |