You can get a list of all the items of a campaign by using the following endpoint.
{warning} Don't forget that all endpoints documented here need to be prefixed with
api/1.0/campaigns/{campaign.id}/
.
Method | Endpoint | Headers |
---|---|---|
GET/HEAD | items |
Default |
{
"data": [
{
"id": 1,
"name": "Spear",
"entry": "\n<p>Lorem Ipsum.</p>\n",
"image": "{path}",
"image_full": "{url}",
"image_thumb": "{url}",
"is_private": true,
"entity_id": 7,
"tags": [],
"created_at": {
"date": "2017-10-31 10:55:08.000000",
"timezone_type": 3,
"timezone": "UTC"
},
"created_by": 1,
"updated_at": {
"date": "2018-09-20 09:18:58.000000",
"timezone_type": 3,
"timezone": "UTC"
},
"updated_by": 1,
"location_id": 4,
"character_id": 2,
"type": "Weapon"
}
]
}
To get the details of a single item, use the following endpoint.
Method | Endpoint | Headers |
---|---|---|
GET/HEAD | items/{item.id} |
Default |
{
"data": {
"id": 1,
"name": "Spear",
"entry": "\n<p>Lorem Ipsum.</p>\n",
"image": "{path}",
"image_full": "{url}",
"image_thumb": "{url}",
"is_private": true,
"entity_id": 7,
"tags": [],
"created_at": {
"date": "2017-10-31 10:55:08.000000",
"timezone_type": 3,
"timezone": "UTC"
},
"created_by": 1,
"updated_at": {
"date": "2018-09-20 09:18:58.000000",
"timezone_type": 3,
"timezone": "UTC"
},
"updated_by": 1,
"location_id": 4,
"character_id": 2,
"type": "Weapon"
}
}
To create a item, use the following endpoint.
Method | Endpoint | Headers |
---|---|---|
POST | items |
Default |
Parameter | Type | Detail |
---|---|---|
name |
string (Required) |
Name of the item |
type |
string |
The item's type |
location_id |
integer |
The item's location |
character_id |
integer |
The item's owner |
tags |
array |
Array of tag ids |
is_private |
boolean |
If the item is only visible to admin members of the campaign |
image |
stream |
Stream to file uploaded to the item |
image_url |
string |
URL to a picture to be used for the item |
{success} Code 200 with JSON body of the new item.
To update a item, use the following endpoint.
Method | Endpoint | Headers |
---|---|---|
PUT/PATCH | items/{item.id} |
Default |
The same body parameters are available as for when creating a item.
{success} Code 200 with JSON body of the updated item.
To delete a item, use the following endpoint.
Method | Endpoint | Headers |
---|---|---|
DELETE | items/{item.id} |
Default |
{success} Code 200 with JSON.