SimpleDAM - API Documentation

An Introduction to the SimpleDAM API Protocol

To find out more about SimpleDAM, please visit the link below.

https://digitalassetmanagementnews.org/features/an-introduction-to-the-simpledam-api-protocol/

Developer Sandbox

Users can try out the various API calls at the link below. You must be logged in to access this page.

https://simpledam.damnews.org/api-sandbox

API Documentation

This page outlines all of the available API calls within Simple DAM. For compliance, DAMs must support calls with a Simple DAM Compatibility Level of at least 0 (zero).

Filter Compatibility Level:

List of Calls

asset
- get
- list
- thumbnail
- preview
- embed
- download
- add
- upload
- update
- delete
- import
user
- login
- logout
- checksession
- get
- list
- add
- update
- delete
user role
- get
- list
- add
- update
- delete
event
- get
- list
event type
- get
- list
- add
- update
- delete

asset

/api/asset/get

Description
Retrieve a single asset

Simple DAM Compatibility Level: 0

Parameters

Request (GET)

sessiontoken (string, required)
A valid session token

id (integer, required)
The unique asset identifier

Response

error (integer)
An error code, or 0 if none

description (string)
Description of the error, or 'success' if none

data (object)
The returned data object

assetid (integer)
The asset identifier

userid (integer)
The user id of the uploader

datecreated (date)
The date the asset was created

datemodified (date)
The date the asset was modified

metadata (object)
The metadata object

filename (string)
The asset's original filename

extension (string)
The asset's extension (e.g. jpg)

mimetype (string)
The asset's mime type

filesize (integer)
The asset's filesize in bytes

fullwidth (integer)
The asset's full width in pixels (if an image)

fullheight (integer)
The asset's full height in pixels (if an image)

previewwidth (integer)
The asset preview's width

previewheight (integer)
The asset preview's height

extensions (object)
Custom metadata extensions, if any

simpledam (object)
The default SimpleDAM metadata extension

description (string)
The asset description

uploader (string)
The name of the user that uploaded the asset

views (integer)
The number of times the asset has been viewed

downloads (integer)
The number of times the asset has been downloaded

Example Call (GET)

/api/asset/get/?sessiontoken=xxxx&id=0a57cb53ba59c46fc4b692527a38a87c78d84028

Example Response

{
	  "error": 0,
	  "description": "success",
	  "data": {
		"assetid": "0a57cb53ba59c46fc4b692527a38a87c78d84028",
		"metadata": {
		  "filename": "altinay-dinc-LluELtL5mK4-unsplash.jpg",
		  "extension": "jpg",
		  "mimetype": "image/jpeg",
		  "filesize": 156303,
		  "fullwidth": 1920,
		  "fullheight": 2880,
		  "previewwidth": 233,
		  "previewheight": 350,
		  "extensions": {
			"simpledam": {
			  "description": "Dramatic cloudy sky with moon",
			  "uploader": "Example User",
			  "views": 5,
			  "downloads": 0
			}
		  }
		},
		"userid": 1,
		"datecreated": "2022-10-11 11:58:45",
		"datemodified": "2022-10-24 15:20:01"
	  }
	}

/api/asset/list

Description
Retrieve a list of assets

Simple DAM Compatibility Level: 0

Parameters

Request (GET)

sessiontoken (string, required)
A valid session token

start (integer, optional)
Record to start from (default: 0)

limit (integer, optional)
Number of records to retrieve (default: 20)

sort (string, optional)
The field to sort on (possible values: assetid, userid, datecreated, datemodified, default: assetid)

dir (string, optional)
The direction of sorting (possible values: asc or desc, default: desc)

q (string, optional)
A keyword or phrase to filter the results by. Fields searched include asset id, filename, mimetype, extension, description, creation date, and metadata.

Response

error (integer)
An error code, or 0 if none

description (string)
Description of the error, or 'success' if none

data (object)
The returned data object

total (integer)
The total number of assets returned by the call

assets (array)
The list of assets (see /api/asset/get for properties of each asset)

Example Call (GET)

/api/asset/list/?sessiontoken=xxxx&start=0&limit=10&sort=datecreated&dir=desc

Example Response

{
	  "error": 0,
	  "description": "success",
	  "data": {
		"total": 28,
		"assets": [
		  {
			"assetid": "0a57cb53ba59c46fc4b692527a38a87c78d84028",
			"metadata": {
			  "filename": "altinay-dinc-LluELtL5mK4-unsplash.jpg",
			  "extension": "jpg",
			  "mimetype": "image/jpeg",
			  "filesize": 156303,
			  "fullwidth": 1920,
			  "fullheight": 2880,
			  "previewwidth": 233,
			  "previewheight": 350,
			  "extensions": {
				"simpledam": {
				  "description": "Dramatic cloudy sky with moon",
				  "uploader": "Example User",
				  "views": 6,
				  "downloads": 0
				}
			  }
			},
			"userid": 1,
			"datecreated": "2022-10-11 11:58:45",
			"datemodified": "2022-10-24 15:20:01"
		  },
		  {
			"assetid": "bc33ea4e26e5e1af1408321416956113a4658763",
			"metadata": {
			  "filename": "paul-steuber-rs11hu-bkTc-unsplash.jpg",
			  "extension": "jpg",
			  "mimetype": "image/jpeg",
			  "filesize": 144355,
			  "fullwidth": 1920,
			  "fullheight": 1280,
			  "previewwidth": 350,
			  "previewheight": 233,
			  "extensions": {
				"simpledam": {
				  "description": "Nike swoosh on front of a building",
				  "uploader": "Example User",
				  "views": 0,
				  "downloads": 0
				}
			  }
			},
			"userid": 1,
			"datecreated": "2022-10-11 11:55:57",
			"datemodified": "2022-10-11 11:56:22"
		  },
		  {
			"assetid": "887309d048beef83ad3eabf2a79a64a389ab1c9f",
			"metadata": {
			  "filename": "sample1.mp3",
			  "extension": "mp3",
			  "mimetype": "audio/mpeg",
			  "filesize": 1954212,
			  "fullwidth": null,
			  "fullheight": null,
			  "previewwidth": null,
			  "previewheight": null,
			  "extensions": {
				"simpledam": {
				  "description": "Example MP3 Audio File",
				  "uploader": "Example User",
				  "views": 0,
				  "downloads": 0
				}
			  }
			},
			"userid": 1,
			"datecreated": "2022-10-11 11:54:45",
			"datemodified": "2022-10-11 11:55:17"
		  },
		  {
			"assetid": "f6e1126cedebf23e1463aee73f9df08783640400",
			"metadata": {
			  "filename": null,
			  "extension": null,
			  "mimetype": null,
			  "filesize": 0,
			  "fullwidth": null,
			  "fullheight": null,
			  "previewwidth": null,
			  "previewheight": null,
			  "extensions": {
				"simpledam": {
				  "description": "Example Metadata-Only Asset",
				  "uploader": "Example User",
				  "views": 0,
				  "downloads": 0
				}
			  }
			},
			"userid": 1,
			"datecreated": "2022-10-10 16:06:31",
			"datemodified": "2022-10-10 16:16:10"
		  },
		  {
			"assetid": "4d134bc072212ace2df385dae143139da74ec0ef",
			"metadata": {
			  "filename": "example-pdf-file.pdf",
			  "extension": "pdf",
			  "mimetype": "application/pdf",
			  "filesize": 716951,
			  "fullwidth": null,
			  "fullheight": null,
			  "previewwidth": 247,
			  "previewheight": 350,
			  "extensions": {
				"simpledam": {
				  "description": "Example PDF File",
				  "uploader": "Example User",
				  "views": 0,
				  "downloads": 0
				}
			  }
			},
			"userid": 1,
			"datecreated": "2022-10-10 13:45:50",
			"datemodified": "2022-10-11 11:26:42"
		  },
		  {
			"assetid": "d435a6cdd786300dff204ee7c2ef942d3e9034e2",
			"metadata": {
			  "filename": "example-photoshop-file.psd",
			  "extension": "psd",
			  "mimetype": "image/vnd.adobe.photoshop",
			  "filesize": 140211,
			  "fullwidth": 842,
			  "fullheight": 595,
			  "previewwidth": 350,
			  "previewheight": 247,
			  "extensions": {
				"simpledam": {
				  "description": "Example Photoshop file",
				  "uploader": "Example User",
				  "views": 0,
				  "downloads": 0
				}
			  }
			},
			"userid": 1,
			"datecreated": "2022-10-08 17:23:26",
			"datemodified": "2022-10-11 11:26:59"
		  },
		  {
			"assetid": "12c6fc06c99a462375eeb3f43dfd832b08ca9e17",
			"metadata": {
			  "filename": "epicurrence-p6mPhlNCfMw-unsplash.jpg",
			  "extension": "jpg",
			  "mimetype": "image/jpeg",
			  "filesize": 586435,
			  "fullwidth": 1920,
			  "fullheight": 1280,
			  "previewwidth": 350,
			  "previewheight": 233,
			  "extensions": {
				"simpledam": {
				  "description": "A retro Volkswagen camper van",
				  "uploader": "Example User",
				  "views": 0,
				  "downloads": 0
				}
			  }
			},
			"userid": 1,
			"datecreated": "2022-10-08 12:35:54",
			"datemodified": "2022-10-11 11:27:23"
		  },
		  {
			"assetid": "472b07b9fcf2c2451e8781e944bf5f77cd8457c8",
			"metadata": {
			  "filename": "bg.jpg",
			  "extension": "jpg",
			  "mimetype": "image/jpeg",
			  "filesize": 216386,
			  "fullwidth": 1920,
			  "fullheight": 1200,
			  "previewwidth": 350,
			  "previewheight": 218,
			  "exif": [],
			  "extensions": {
				"simpledam": {
				  "description": "Graphic of a Japanese-inspired landscape",
				  "uploader": "Example User",
				  "views": 0,
				  "downloads": 0
				}
			  }
			},
			"userid": 1,
			"datecreated": "2022-10-08 12:04:29",
			"datemodified": "2022-10-11 11:28:25"
		  },
		  {
			"assetid": "91032ad7bbcb6cf72875e8e8207dcfba80173f7c",
			"metadata": {
			  "filename": "nguyen-dang-hoang-nhu-SjqrtZOd9Uc-unsplash.jpg",
			  "extension": "jpg",
			  "mimetype": "image/jpeg",
			  "filesize": 714647,
			  "fullwidth": 1920,
			  "fullheight": 2880,
			  "previewwidth": 233,
			  "previewheight": 350,
			  "exif": [],
			  "extensions": {
				"simpledam": {
				  "description": "retro orange telephone",
				  "uploader": "Example User",
				  "views": 0,
				  "downloads": 0
				}
			  }
			},
			"userid": 1,
			"datecreated": "2022-10-08 03:37:24",
			"datemodified": "2022-10-11 11:28:53"
		  },
		  {
			"assetid": "b3f0c7f6bb763af1be91d9e74eabfeb199dc1f1f",
			"metadata": {
			  "filename": "philipp-pilz-QZ2EQuPpQJs-unsplash.jpg",
			  "extension": "jpg",
			  "mimetype": "image/jpeg",
			  "filesize": 443146,
			  "fullwidth": 1920,
			  "fullheight": 2880,
			  "previewwidth": 233,
			  "previewheight": 350,
			  "extensions": {
				"simpledam": {
				  "description": "A snarling wolf",
				  "uploader": "Example User",
				  "views": 0,
				  "downloads": 0
				}
			  }
			},
			"userid": 1,
			"datecreated": "2022-10-08 02:18:11",
			"datemodified": "2022-10-11 11:29:14"
		  },
		  {
			"assetid": "9e6a55b6b4563e652a23be9d623ca5055c356940",
			"metadata": {
			  "example": "Here's an example metadata node",
			  "filename": "readme.txt",
			  "extension": "txt",
			  "mimetype": "text/plain",
			  "filesize": 3001,
			  "fullwidth": null,
			  "fullheight": null,
			  "previewwidth": null,
			  "previewheight": null,
			  "extensions": {
				"simpledam": {
				  "description": "Example plain text file",
				  "uploader": "Example User",
				  "views": 0,
				  "downloads": 0
				}
			  }
			},
			"userid": 1,
			"datecreated": "2022-10-08 02:15:41",
			"datemodified": "2022-10-11 11:29:41"
		  },
		  {
			"assetid": "0716d9708d321ffb6a00818614779e779925365c",
			"metadata": {
			  "filename": "addresses.csv",
			  "extension": "csv",
			  "mimetype": "text/csv",
			  "filesize": 328,
			  "fullwidth": null,
			  "fullheight": null,
			  "previewwidth": null,
			  "previewheight": null,
			  "extensions": {
				"simpledam": {
				  "description": "Example plain text CSV File",
				  "uploader": "Example User",
				  "views": 0,
				  "downloads": 0
				}
			  }
			},
			"userid": 1,
			"datecreated": "2022-10-08 02:11:53",
			"datemodified": "2022-10-11 11:30:03"
		  },
		  {
			"assetid": "1574bddb75c78a6fd2251d61e2993b5146201319",
			"metadata": {
			  "filename": "Sample-Spreadsheet.zip",
			  "extension": "zip",
			  "mimetype": "application/zip",
			  "filesize": 351,
			  "fullwidth": null,
			  "fullheight": null,
			  "previewwidth": null,
			  "previewheight": null,
			  "extensions": {
				"simpledam": {
				  "description": "Example ZIP File",
				  "uploader": "Example User",
				  "views": 0,
				  "downloads": 0
				}
			  }
			},
			"userid": 1,
			"datecreated": "2022-10-08 02:09:27",
			"datemodified": "2022-10-11 11:30:44"
		  },
		  {
			"assetid": "f1abd670358e036c31296e66b3b66c382ac00812",
			"metadata": {
			  "filename": "frank-okay-R1J6Z1cnJZc-unsplash.jpg",
			  "extension": "jpg",
			  "mimetype": "image/jpeg",
			  "filesize": 629253,
			  "fullwidth": 1920,
			  "fullheight": 1280,
			  "previewwidth": 350,
			  "previewheight": 233,
			  "extensions": {
				"simpledam": {
				  "description": "retro TV set on a suburban street at night",
				  "uploader": "Example User",
				  "views": 0,
				  "downloads": 0
				}
			  }
			},
			"userid": 1,
			"datecreated": "2022-10-07 07:38:25",
			"datemodified": "2022-10-11 11:31:05"
		  },
		  {
			"assetid": "fa35e192121eabf3dabf9f5ea6abdbcbc107ac3b",
			"metadata": {
			  "filename": "sheraz-shaikh-Zx3kcU2Kw9E-unsplash.jpg",
			  "extension": "jpg",
			  "mimetype": "image/jpeg",
			  "filesize": 365968,
			  "fullwidth": 1920,
			  "fullheight": 1280,
			  "previewwidth": 350,
			  "previewheight": 233,
			  "extensions": {
				"simpledam": {
				  "description": "sliced oranges",
				  "uploader": "Example User",
				  "views": 0,
				  "downloads": 0
				}
			  }
			},
			"userid": 1,
			"datecreated": "2022-10-07 07:33:02",
			"datemodified": "2022-10-11 11:31:26"
		  },
		  {
			"assetid": "bd307a3ec329e10a2cff8fb87480823da114f8f4",
			"metadata": {
			  "filename": "boris-smokrovic-lyvCvA8sKGc-unsplash.jpg",
			  "extension": "jpg",
			  "mimetype": "image/jpeg",
			  "filesize": 268161,
			  "fullwidth": 1920,
			  "fullheight": 1280,
			  "previewwidth": 350,
			  "previewheight": 233,
			  "extensions": {
				"simpledam": {
				  "description": "butterfly on an orange flower",
				  "uploader": "Example User",
				  "views": 0,
				  "downloads": 0
				}
			  }
			},
			"userid": 1,
			"datecreated": "2022-10-07 07:30:16",
			"datemodified": "2022-10-20 18:04:25"
		  },
		  {
			"assetid": "7b52009b64fd0a2a49e6d8a939753077792b0554",
			"metadata": {
			  "filename": "hakon-sataoen-yQ9mZzBdDAM-unsplash.jpg",
			  "extension": "jpg",
			  "mimetype": "image/jpeg",
			  "filesize": 278503,
			  "fullwidth": 1920,
			  "fullheight": 1207,
			  "previewwidth": 350,
			  "previewheight": 220,
			  "extensions": {
				"simpledam": {
				  "description": "orange sports car against a stormy sky",
				  "uploader": "Example User",
				  "views": 0,
				  "downloads": 0
				}
			  }
			},
			"userid": 1,
			"datecreated": "2022-10-07 07:29:52",
			"datemodified": "2022-10-11 11:32:26"
		  },
		  {
			"assetid": "17ba0791499db908433b80f37c5fbc89b870084b",
			"metadata": {
			  "filename": "tim-mossholder-KsdgjODuJQE-unsplash.jpg",
			  "extension": "jpg",
			  "mimetype": "image/jpeg",
			  "filesize": 323380,
			  "fullwidth": 1920,
			  "fullheight": 1280,
			  "previewwidth": 350,
			  "previewheight": 233,
			  "extensions": {
				"simpledam": {
				  "description": "dog looking out of an orange car window",
				  "uploader": "Example User",
				  "views": 0,
				  "downloads": 0
				}
			  }
			},
			"userid": 1,
			"datecreated": "2022-10-07 07:29:21",
			"datemodified": "2022-10-11 11:32:50"
		  },
		  {
			"assetid": "b1d5781111d84f7b3fe45a0852e59758cd7a87e5",
			"metadata": {
			  "filename": "oli-woodman-yM2Uo_1xZ3I-unsplash.jpg",
			  "extension": "jpg",
			  "mimetype": "image/jpeg",
			  "filesize": 381335,
			  "fullwidth": 1920,
			  "fullheight": 1280,
			  "previewwidth": 350,
			  "previewheight": 233,
			  "extensions": {
				"simpledam": {
				  "description": "An orange retro Porsche car",
				  "uploader": "Example User",
				  "views": 0,
				  "downloads": 0
				}
			  }
			},
			"userid": 1,
			"datecreated": "2022-10-07 07:28:49",
			"datemodified": "2022-10-11 11:33:09"
		  },
		  {
			"assetid": "0ade7c2cf97f75d009975f4d720d1fa6c19f4897",
			"metadata": {
			  "filename": "IMG_1150.jpg",
			  "extension": "jpg",
			  "mimetype": "image/jpeg",
			  "filesize": 1797157,
			  "fullwidth": 2592,
			  "fullheight": 1944,
			  "previewwidth": 350,
			  "previewheight": 262,
			  "extensions": {
				"simpledam": {
				  "description": "London Bridge street sign",
				  "uploader": "Example User",
				  "views": 2,
				  "downloads": 1
				},
				"exif": {
				  "IFD0": {
					"Make": "Canon",
					"Model": "Canon DIGITAL IXUS 500",
					"Orientation": 1,
					"XResolution": "180/1",
					"YResolution": "180/1",
					"ResolutionUnit": 2,
					"DateTime": "2007:04:06 16:59:01",
					"YCbCrPositioning": 1,
					"Exif_IFD_Pointer": 196
				  },
				  "EXIF": {
					"ExposureTime": "1/500",
					"FNumber": "28/10",
					"ExifVersion": "0220",
					"DateTimeOriginal": "2007:04:06 16:59:01",
					"DateTimeDigitized": "2007:04:06 16:59:01",
					"ComponentsConfiguration": "\\u0001\\u0002\\u0003",
					"CompressedBitsPerPixel": "3/1",
					"ShutterSpeedValue": "287/32",
					"ApertureValue": "95/32",
					"ExposureBiasValue": "0/3",
					"MaxApertureValue": "95/32",
					"MeteringMode": 5,
					"Flash": 24,
					"FocalLength": "237/32",
					"MakerNote": "\\u0011",
					"UserComment": "",
					"FlashPixVersion": "0100",
					"ColorSpace": 1,
					"ExifImageWidth": 2592,
					"ExifImageLength": 1944,
					"InteroperabilityOffset": 1860,
					"FocalPlaneXResolution": "2592000/283",
					"FocalPlaneYResolution": "1944000/212",
					"FocalPlaneResolutionUnit": 2,
					"SensingMethod": 2,
					"FileSource": "\\u0003",
					"CustomRendered": 0,
					"ExposureMode": 0,
					"WhiteBalance": 0,
					"DigitalZoomRatio": "2592/2592",
					"SceneCaptureType": 0
				  }
				}
			  }
			},
			"userid": 1,
			"datecreated": "2022-10-07 07:11:28",
			"datemodified": "2022-10-27 10:21:55"
		  }
		]
	  }
	}

/api/asset/thumbnail

Description
Return a thumbnail image (JPEG) for any given asset

Simple DAM Compatibility Level: 0

Parameters

Request (GET)

sessiontoken (string, required)
A valid session token

id (integer, required)
The ID of the asset to retrieve a thumbnail for

Response

error (integer)
An error code, 0 if none

description (string)
Description of the error, or 'success' if none

thumbnail (binary)
A JPEG image (if a preview is available)

Example Call (GET)

/api/asset/thumbnail/?sessiontoken=xxxx&id=0a57cb53ba59c46fc4b692527a38a87c78d84028

Example Response

Returns binary image data with image/jpeg mimetype

/api/asset/preview

Description
Return a preview image (JPEG) for any given asset

Simple DAM Compatibility Level: 0

Parameters

Request (GET)

sessiontoken (string, required)
A valid session token

id (integer, required)
The ID of the asset to get a preview for

Response

error (integer)
An error code, 0 if none

description (string)
Description of the error, or 'success' if none

preview (binary)
A JPEG image (if available)

Example Call (GET)

/api/asset/preview/?sessiontoken=xxxx&id=0a57cb53ba59c46fc4b692527a38a87c78d84028

Example Response

Returns binary image data with image/jpeg mimetype

/api/asset/embed

Description
Attempt to stream/embed an asset for display in a browser or app (using its mime type)

Simple DAM Compatibility Level: 0

Parameters

Request (GET)

sessiontoken (string, required)
A valid session token

id (integer, required)
The unique ID of the asset

Response

error (integer)
An error code, 0 if none

description (string)
Description of the error, or 'success' if none

data (binary)
The asset's binary data and mime type

Example Call (GET)

/api/asset/embed/?sessiontoken=xxxx&id=0a57cb53ba59c46fc4b692527a38a87c78d84028

Example Response

Returns binary asset data with stored mimetype

/api/asset/download

Description
Download an asset

Simple DAM Compatibility Level: 0

Parameters

Request (GET)

sessiontoken (string, required)
A valid session token

id (integer, required)
The unique asset identifier

Response

error (integer)
An error code, or 0 if none

description (string)
Description of the error, or 'success' if none

file (file)
If successful, a download file is delivered

Example Call (GET)

/api/asset/download/?sessiontoken=xxxx&id=0a57cb53ba59c46fc4b692527a38a87c78d84028

Example Response

Returns the binary data with a download prompt

/api/asset/add

Description
Creates a metadata-only asset with no binary data (i.e. no file). This requires an administrator account.

Simple DAM Compatibility Level: 0

Parameters

Request (POST)

sessiontoken (string, required)
A valid session token

metadata (json, optional)
A well-formed JSON object containing arbitrary data. The SimpleDAM extension is automatically appended.

Response

error (integer)
An error code, or 0 if none

description (string)
Description of the error, or 'success' if none

data (object)
The returned data object

assetid (integer)
The unique identifier of the new asset

Example Call (POST)

/api/asset/add/?sessiontoken=xxxx&metadata={"valid":"json"}

Example Response

{
	  "error": 0,
	  "description": "success",
	  "data": {
		"assetid": "cb4e5208b4cd87268b208e49452ed6e89a68e0b8"
	  }
	}

/api/asset/upload

Description
Creates a new asset using either a file upload or a valid file URL. This requires an administrator account.

Simple DAM Compatibility Level: 0

Parameters

Request (POST)

sessiontoken (string, required)
A valid session token

metadata (json, optional)
A well-formed JSON object containing arbitrary data. The SimpleDAM extension is automatically appended.

file (binary, optional)
A file of supported type (if not provided, a URL is required)

url (string, optional)
A valid URL pointing to a file (if not provided, a file is required)

Response

Example Call (POST)

/api/asset/upload/?sessiontoken=xxxx&url=[valid-url-of-file]&metadata={"valid":"json"}

Example Response

{
	  "error": 0,
	  "description": "success",
	  "data": {
		"assetid": "cb4e5208b4cd87268b208e49452ed6e89a68e0b8"
	  }
	}

/api/asset/update

Description
Updates an existing asset. If adding or replacing a file, an upload or valid file URL can be provided. This requires an administrator account.

Simple DAM Compatibility Level: 0

Parameters

Request (POST)

sessiontoken (string, required)
A valid session token

id (integer, required)
The unique id of the asset to be updated

metadata (json, optional)
A well-formed JSON object containing arbitrary data. The SimpleDAM extension is automatically appended.

file (binary, optional)
A file of supported type

url (string, optional)
A valid URL pointing to a file

merge (boolean, optional)
If present, the posted metadata is merged with the existing metadata

Response

Example Call (POST)

/api/asset/update/?sessiontoken=xxxx&id=cb4e5208b4cd87268b208e49452ed6e89a68e0b8&file=[binary-data]&metadata={"valid":"json"}

Example Response

{
	  "error": 0,
	  "description": "success",
	  "data": {
		"assetid": "cb4e5208b4cd87268b208e49452ed6e89a68e0b8"
	  }
	}

/api/asset/delete

Description
Delete an existing asset. This requires an administrator account.

Simple DAM Compatibility Level: 0

Parameters

Request (POST)

sessiontoken (string, required)
A valid session token

id (integer, required)
The unique id of the asset to be deleted

Response

Example Call (POST)

/api/asset/delete/?sessiontoken=xxxx&id=cb4e5208b4cd87268b208e49452ed6e89a68e0b8

Example Response

{
	  "error": 0,
	  "description": "success",
	  "data": {
		"assetid": "cb4e5208b4cd87268b208e49452ed6e89a68e0b8"
	  }
	}

/api/asset/import

Description
Imports assets from the local watch folder. This can be specified in the API settings file.

Simple DAM Compatibility Level: 1

Parameters

Request (GET)

sessiontoken (string, required)
A valid session token

source (string, required)
The source of the files to import (default: local)

Response

error (integer)
An error code, 0 if none

description (string)
Description of the error, or 'success' if none

data (object)
The returned data object

total (integer)
The total number of imports discovered

numimported (integer)
The number of successful imports

numfailed (integer)
The number of failed imports

imported (array)
The list of assets imported

failed (array)
The list of failed assets

Example Call (GET)

/api/asset/import/?sessiontoken=xxxx&source=local

Example Response

{
	  "error": 0,
	  "description": "success",
	  "data": {
		"total": 10,
		"numimported": 10,
		"numfailed": 0,
		"imported": [
		  {
			"assetid": 123,
			"key": "value",
			"foo": "bar"
		  },
		  {
			"assetid": 124,
			"key": "value",
			"foo": "bar"
		  },
		  {
			"assetid": 125,
			"key": "value",
			"foo": "bar"
		  }
		],
		"failed": []
	  }
	}

user

/api/user/login

Description
Logs a user in

Simple DAM Compatibility Level: 0

Parameters

Request (POST)

email (string, required)
The user's email address

password (string, required)
The user's password

Response

error (integer)
An error code, or 0 if none

description (string)
Description of the error, or 'success' if none

data (object)
The returned data object

user (object)
The user object

userid (string)
The user id

firstname (string)
The user's first name

lastname (string)
The user's last name

userroleid (integer)
The user's role (1: normal, 2: admin)

session (object)
The session object

sessiontoken (string)
The session token to use for subsequent API calls

sessiontimestamp (string)
The unix timestamp of the session token

Example Call (POST)

/api/user/login/?email=xxxx&password=xxxx

Example Response

{
	  "error": 0,
	  "description": "success",
	  "data": {
		"user": {
		  "userid": 3,
		  "firstname": "Example",
		  "lastname": "User",
		  "userroleid": 1
		},
		"session": {
		  "sessiontoken": "9974-5539-6b0f-400d-acb8-ee84-2eb9-fc87",
		  "sessiontimestamp": 1666826692
		}
	  }
	}

/api/user/logout

Description
Logs a user out

Simple DAM Compatibility Level: 0

Parameters

Request (GET)

sessiontoken (string, required)
A valid session token

Response

error (integer)
An error code, or 0 if none

description (string)
Description of the error, or 'success' if none

Example Call (GET)

/api/user/logout/?sessiontoken=xxxx

Example Response

{
	  "error": 0,
	  "description": "success"
	}

/api/user/checksession

Description
Checks whether a session token is valid, and if so, returns its details

Simple DAM Compatibility Level: 0

Parameters

Request (POST)

sessiontoken (string, required)
A valid session token

Response

error (integer)
An error code, or 0 if none

description (string)
Description of the error, or 'success' if none

data (object)
The returned data object

sessionid (integer)
The session token's unique identifier

userid (string)
The user's id

sessiontoken (string)
The session token itself - used for API calls

sessiontimestamp (string)
The session token's unix timestamp

firstname (string)
The user's first name

lastname (string)
The user's last name

userroleid (integer)
The user's role type id (1: normal, 2: admin)

Example Call (POST)

/api/user/checksession/?sessiontoken=09f2-927e-bdec-4cba-a45e-694f-6e52-026b

Example Response

{
	  "error": 0,
	  "description": "success",
	  "data": {
		"sessionid": 20,
		"userid": 3,
		"sessiontoken": "09f2-927e-bdec-4cba-a45e-694f-6e52-026b",
		"sessiontimestamp": 1666826795,
		"firstname": "Example",
		"lastname": "User",
		"userroleid": 1
	  }
	}

/api/user/get

Description
Get a single user's details. This requires an administrator account if requesting a different user.

Simple DAM Compatibility Level: 1

Parameters

Request (GET)

sessiontoken (string, required)
A valid session token

id (integer, required)
The unique ID of the user to be retrieved

Response

error (integer)
An error code, or 0 if none

description (string)
Description of the error, or 'success' if none

data (object)
The returned data object

userid (integer)
The user's unique identifier

firstname (string)
The user's first name

lastname (string)
The user's last name

email (string)
The user's registered email address

userroleid (integer)
The user's role type id (1: normal, 2: admin)

lastlogindate (date)
The the date the user last logged in

datecreated (date)
The date the user was created

datemodified (date)
The date the user was last updated

Example Call (GET)

/api/user/get/?sessiontoken=xxxx&id=1

Example Response

{
	  "error": 0,
	  "description": "success",
	  "data": {
		"userid": 1,
		"firstname": "Example",
		"lastname": "User",
		"email": "mail@example.com",
		"userroleid": 1,
		"lastlogindate": "2022-08-12 11:39:20",
		"datecreated": "2018-11-02 13:45:27",
		"datemodified": "2022-10-24 12:37:35"
	  }
	}

/api/user/list

Description
Retrieve a list of users. This requires an administrator account.

Simple DAM Compatibility Level: 1

Parameters

Request (GET)

sessiontoken (string, required)
A valid session token

start (integer, optional)
Record to start from (default: 0)

limit (integer, optional)
Number of records to retrieve (default: 20)

sort (string, optional)
The field to sort on (possible values: userid, firstname, lastname, email, lastlogindate, datecreated, datemodified, userroleid, userrolename, default: userid)

dir (string, optional)
The direction of sorting (possible values: asc or desc, default: asc)

r (string, optional)
A user role id to filter the results by

q (string, optional)
A keyword or phrase to filter the results by

Response

error (integer)
An error code, or 0 if none

description (string)
Description of the error, or 'success' if none

data (object)
The returned data object

total (integer)
The total number of users returned by the call

users (array)
The list of users (see /api/user/get for properties of each user)

Example Call (GET)

/api/user/list/?sessiontoken=xxxx&start=10&limit=10&sort=lastname&dir=asc

Example Response

{
	  "error": 0,
	  "description": "success",
	  "data": {
		"total": 3,
		"users": [
		  {
			"userid": 1,
			"firstname": "Joe",
			"lastname": "Bloggs",
			"email": "bloggs@example.com",
			"userroleid": 2,
			"userrolename": "Administrator",
			"lastlogindate": "2022-08-12 11:39:20",
			"datecreated": "2018-11-02 13:45:27",
			"datemodified": "2022-10-24 12:37:35"
		  },
		  {
			"userid": 2,
			"firstname": "Mary",
			"lastname": "Jane",
			"email": "mary@example.com",
			"userroleid": 2,
			"userrolename": "Administrator",
			"lastlogindate": "2022-08-10 12:11:47",
			"datecreated": "2018-11-02 13:45:27",
			"datemodified": "2022-10-19 13:31:53"
		  },
		  {
			"userid": 3,
			"firstname": "Example",
			"lastname": "User",
			"email": "mail@example.com",
			"userroleid": 1,
			"userrolename": "Normal",
			"lastlogindate": null,
			"datecreated": "2022-08-15 15:18:05",
			"datemodified": "2022-08-15 15:18:05"
		  }
		]
	  }
	}

/api/user/add

Description
Create a new user. This requires an administrator account.

Simple DAM Compatibility Level: 1

Parameters

Request (POST)

sessiontoken (string, required)
A valid session token

firstname (string, required)
The first name of the new user

lastname (string, required)
The last name of the new user

email (string, required)
A valid email address for the user

userroleid (integer, required)
The role type of the new user (1: normal, 2: admin)

password (string, required)
A strong password

password2 (string, required)
Confirmation of the password

Response

error (integer)
An error code, or 0 if none

description (string)
Description of the error, or 'success' if none

data (object)
The returned data object

userid (integer)
The unique identifier of the new user

Example Call (POST)

/api/user/add/?sessiontoken=xxxx&firstname=Joe&lastname=Bloggs&email=bloggs@example.com&userroleid=1&password=xxxx&password2=xxxx

Example Response

{
	  "error": 0,
	  "description": "success",
	  "data": {
		"userid": "4"
	  }
	}

/api/user/update

Description
Update an existing user. This requires an administrator account if updating a different user.

Simple DAM Compatibility Level: 1

Parameters

Request (POST)

sessiontoken (string, required)
A valid session token

id (integer, required)
The user's unique identifier

firstname (string, optional)
The first name of the existing user

lastname (string, optional)
The last name of the existing user

email (string, optional)
A valid email address for the user

userroleid (integer, optional)
The role type of the new user (1: normal, 2: admin)

password (string, optional)
A unique password (only required if changing)

password2 (string, optional)
Confirmation of the password (only required if changing)

Response

Example Call (POST)

/api/user/update/?sessiontoken=xxxx&id=123&firstname=Joanne

Example Response

{
	  "error": 0,
	  "description": "success",
	  "data": {
		"userid": "4"
	  }
	}

/api/user/delete

Description
Delete an existing user. This requires an administrator account.

Simple DAM Compatibility Level: 1

Parameters

Request (POST)

sessiontoken (string, required)
A valid session token

id (integer, required)
The unique id of the user to be deleted

Response

Example Call (POST)

/api/user/delete/?sessiontoken=xxxx&id=123

Example Response

{
	  "error": 0,
	  "description": "success",
	  "data": {
		"userid": "4"
	  }
	}

user role

/api/userrole/get

Description
Get a specific user role. This requires an administrator account.

Simple DAM Compatibility Level: 1

Parameters

Request (GET)

sessiontoken (string, required)
A valid session token

id (integer, required)
The unique ID of the user role to be retrieved

Response

error (integer)
An error code, or 0 if none

description (string)
Description of the error, or 'success' if none

data (object)
The returned data object

userroleid (integer)
The user role's unique identifier

userrolename (string)
The user role's name

Example Call (GET)

/api/userrole/get/?sessiontoken=xxxx&id=1

Example Response

{
	  "error": 0,
	  "description": "success",
	  "data": {
		"userroleid": 1,
		"userrolename": "Normal"
	  }
	}

/api/userrole/list

Description
Retrieve a list of user roles. This requires an administrator account.

Simple DAM Compatibility Level: 1

Parameters

Request (GET)

Response

error (integer)
An error code, or 0 if none

description (string)
Description of the error, or 'success' if none

data (object)
The returned data object

total (integer)
The total number of user roles returned by the call

userroles (array)
The list of user roles (see /api/userrole/get for properties of each user role)

Example Call (GET)

/api/userrole/list/?sessiontoken=xxxx&start=0&limit=10&sort=userrolename&dir=asc

Example Response

{
	  "error": 0,
	  "description": "success",
	  "data": {
		"total": 2,
		"userroles": [
		  {
			"userroleid": 2,
			"userrolename": "Administrator"
		  },
		  {
			"userroleid": 1,
			"userrolename": "Normal"
		  }
		]
	  }
	}

/api/userrole/add

Description
Create a new user role. This requires an administrator account.

Simple DAM Compatibility Level: 1

Parameters

Request (POST)

sessiontoken (string, required)
A valid session token

userrolename (string, required)
The name of the new user role

Response

error (integer)
An error code, or 0 if none

description (string)
Description of the error, or 'success' if none

data (object)
The returned data object

userroleid (integer)
The unique identifier of the new user role

Example Call (POST)

/api/userrole/add/?sessiontoken=xxxx&userrolename=Super+Administrator

Example Response

{
	  "error": 0,
	  "description": "success",
	  "data": {
		"userroleid": "3"
	  }
	}

/api/userrole/update

Description
Update an existing user role. This requires an administrator account.

Simple DAM Compatibility Level: 1

Parameters

Request (POST)

sessiontoken (string, required)
A valid session token

id (integer, required)
The user role's unique identifier

userrolename (string, required)
The new name for the existing user role

Response

Example Call (POST)

/api/userrole/update/?sessiontoken=xxxx&id=2&userrolename=New+Role+Name

Example Response

{
	  "error": 0,
	  "description": "success",
	  "data": {
		"userroleid": "2"
	  }
	}

/api/userrole/delete

Description
Delete an existing user role. This requires an administrator account. Warning: existing users must first be updated to a new role if they are assigned a role that is to be deleted!

Simple DAM Compatibility Level: 1

Parameters

Request (POST)

sessiontoken (string, required)
A valid session token

id (integer, required)
The unique id of the user role to be deleted

Response

Example Call (POST)

/api/userrole/delete/?sessiontoken=xxxx&id=3

Example Response

{
	  "error": 0,
	  "description": "success",
	  "data": {
		"userroleid": "3"
	  }
	}

event

/api/event/get

Description
Get a specific event. This requires an administrator account.

Simple DAM Compatibility Level: 1

Parameters

Request (GET)

sessiontoken (string, required)
A valid session token

id (integer, required)
The unique ID of the event to be retrieved

Response

error (integer)
An error code, or 0 if none

description (string)
Description of the error, or 'success' if none

data (object)
The returned data object

eventid (integer)
The event's unique identifier

eventtypeid (integer)
The type of the event

eventtypename (string)
The name of the event

userid (integer)
The id of the event's calling user

assetid (integer)
The unique of an asset, if the event relates to one

eventip (string)
The IP address of the calling computer/device

eventdetails (string)
The details of the event

apiurl (string)
The API entry point URL for this call

apimethod (string)
The request type of the event (GET/POST)

eventdate (date)
The date of the event

Example Call (GET)

/api/event/get/?sessiontoken=xxxx&id=12

Example Response

{
	  "error": 0,
	  "description": "success",
	  "data": {
		"eventid": 12,
		"eventtypeid": 8,
		"eventtypename": "list assets",
		"userid": 1,
		"assetid": null,
		"eventip": "127.0.0.1",
		"eventdetails": "Example User listed assets",
		"apiurl": "/api/asset/list/?start=0&limit=20&sort=assetid&dir=desc&q=",
		"apimethod": "GET",
		"eventdate": "2022-10-24 18:25:33"
	  }
	}

/api/event/list

Description
Retrieve a list of events. This requires an administrator account.

Simple DAM Compatibility Level: 1

Parameters

Request (GET)

sessiontoken (string, required)
A valid session token

start (integer, optional)
Record to start from (default: 0)

limit (integer, optional)
Number of records to retrieve (default: 20)

sort (string, optional)
The field to sort on (possible values: eventid, eventtypeid, eventtypename, eventip, userid, userroleid, apimethod, eventdate, firstname, lastname, default: eventid)

dir (string, optional)
The direction of sorting (possible values: asc or desc, default: desc)

t (integer, optional)
An event type id to filter events by

q (string, optional)
A keyword to filter events by

Response

error (integer)
An error code, or 0 if none

description (string)
Description of the error, or 'success' if none

data (object)
The returned data object

total (integer)
The total number of events returned by the call

events (array)
The list of events (see /api/event/get for properties of each event)

Example Call (GET)

/api/event/list/?sessiontoken=xxxx&start=11&limit=10&sort=eventid&dir=desc

Example Response

{
	  "error": 0,
	  "description": "success",
	  "data": {
		"total": 153,
		"events": [
		  {
			"eventid": 142,
			"eventtypeid": 2,
			"eventtypename": "log out",
			"userid": 3,
			"assetid": null,
			"eventip": "10.0.2.2",
			"eventdetails": "Example User logged out",
			"apiurl": "\\/api\\/user\\/logout\\/?",
			"apimethod": "GET",
			"eventdate": "2022-10-27 00:27:23",
			"firstname": "Example",
			"lastname": "User"
		  },
		  {
			"eventid": 141,
			"eventtypeid": 8,
			"eventtypename": "list assets",
			"userid": 3,
			"assetid": null,
			"eventip": "10.0.2.2",
			"eventdetails": "Example User listed assets",
			"apiurl": "\\/api\\/asset\\/list\\/?start=0&limit=20&sort=assetid&dir=desc&q=",
			"apimethod": "GET",
			"eventdate": "2022-10-27 00:27:17",
			"firstname": "Example",
			"lastname": "User"
		  },
		  {
			"eventid": 140,
			"eventtypeid": 8,
			"eventtypename": "list assets",
			"userid": 3,
			"assetid": null,
			"eventip": "10.0.2.2",
			"eventdetails": "Example User listed assets",
			"apiurl": "\\/api\\/asset\\/list\\/?start=0&limit=20&sort=assetid&dir=desc&q=",
			"apimethod": "GET",
			"eventdate": "2022-10-27 00:26:36",
			"firstname": "Example",
			"lastname": "User"
		  },
		  {
			"eventid": 139,
			"eventtypeid": 1,
			"eventtypename": "log in",
			"userid": 3,
			"assetid": null,
			"eventip": "10.0.2.2",
			"eventdetails": "Example User logged in",
			"apiurl": "\\/api\\/user\\/login\\/",
			"apimethod": "POST",
			"eventdate": "2022-10-27 00:26:31",
			"firstname": "Example",
			"lastname": "User"
		  },
		  {
			"eventid": 138,
			"eventtypeid": 1,
			"eventtypename": "log in",
			"userid": 3,
			"assetid": null,
			"eventip": "10.0.2.2",
			"eventdetails": "Example User logged in",
			"apiurl": "\\/api\\/user\\/login\\/",
			"apimethod": "POST",
			"eventdate": "2022-10-27 00:24:52",
			"firstname": "Example",
			"lastname": "User"
		  },
		  {
			"eventid": 137,
			"eventtypeid": 2,
			"eventtypename": "log out",
			"userid": 3,
			"assetid": null,
			"eventip": "10.0.2.2",
			"eventdetails": "Example User logged out",
			"apiurl": "\\/api\\/user\\/logout\\/?",
			"apimethod": "GET",
			"eventdate": "2022-10-27 00:24:44",
			"firstname": "Example",
			"lastname": "User"
		  },
		  {
			"eventid": 136,
			"eventtypeid": 8,
			"eventtypename": "list assets",
			"userid": 3,
			"assetid": null,
			"eventip": "10.0.2.2",
			"eventdetails": "Example User listed assets",
			"apiurl": "\\/api\\/asset\\/list\\/?start=0&limit=20&sort=assetid&dir=desc&q=",
			"apimethod": "GET",
			"eventdate": "2022-10-27 00:22:58",
			"firstname": "Example",
			"lastname": "User"
		  },
		  {
			"eventid": 135,
			"eventtypeid": 1,
			"eventtypename": "log in",
			"userid": 3,
			"assetid": null,
			"eventip": "10.0.2.2",
			"eventdetails": "Example User logged in",
			"apiurl": "\\/api\\/user\\/login\\/",
			"apimethod": "POST",
			"eventdate": "2022-10-27 00:22:57",
			"firstname": "Example",
			"lastname": "User"
		  },
		  {
			"eventid": 134,
			"eventtypeid": 2,
			"eventtypename": "log out",
			"userid": 3,
			"assetid": null,
			"eventip": "10.0.2.2",
			"eventdetails": "Example User logged out",
			"apiurl": "\\/api\\/user\\/logout\\/?",
			"apimethod": "GET",
			"eventdate": "2022-10-27 00:22:50",
			"firstname": "Example",
			"lastname": "User"
		  },
		  {
			"eventid": 133,
			"eventtypeid": 8,
			"eventtypename": "list assets",
			"userid": 3,
			"assetid": null,
			"eventip": "10.0.2.2",
			"eventdetails": "Example User listed assets",
			"apiurl": "\\/api\\/asset\\/list\\/?start=0&limit=20&sort=assetid&dir=desc&q=",
			"apimethod": "GET",
			"eventdate": "2022-10-27 00:21:45",
			"firstname": "Example",
			"lastname": "User"
		  }
		]
	  }
	}

event type

/api/eventtype/get

Description
Get a specific event type. This requires an administrator account.

Simple DAM Compatibility Level: 1

Parameters

Request (GET)

sessiontoken (string, required)
A valid session token

id (integer, required)
The unique ID of the event type to be retrieved

Response

error (integer)
An error code, or 0 if none

description (string)
Description of the error, or 'success' if none

data (object)
The returned data object

eventtypeid (integer)
The event type's unique identifier

eventtypename (string)
The event type's name

Example Call (GET)

/api/eventtype/get/?sessiontoken=xxxx&id=1

Example Response

{
	  "error": 0,
	  "description": "success",
	  "data": {
		"eventtypeid": 9,
		"eventtypename": "download asset"
	  }
	}

/api/eventtype/list

Description
Retrieve a list of event types. This requires an administrator account.

Simple DAM Compatibility Level: 1

Parameters

Request (GET)

Response

error (integer)
An error code, or 0 if none

description (string)
Description of the error, or 'success' if none

data (object)
The returned data object

total (integer)
The total number of event types returned by the call

eventtypes (array)
The list of event types (see /api/eventtype/get for properties of each event type)

Example Call (GET)

/api/eventtype/list/?sessiontoken=xxxx&start=0&limit=10&sort=eventtypeid&dir=asc

Example Response

{
	  "error": 0,
	  "description": "success",
	  "data": {
		"total": 24,
		"eventtypes": [
		  {
			"eventtypeid": 1,
			"eventtypename": "log in"
		  },
		  {
			"eventtypeid": 2,
			"eventtypename": "log out"
		  },
		  {
			"eventtypeid": 3,
			"eventtypename": "get user"
		  },
		  {
			"eventtypeid": 4,
			"eventtypename": "list users"
		  },
		  {
			"eventtypeid": 5,
			"eventtypename": "add user"
		  },
		  {
			"eventtypeid": 6,
			"eventtypename": "update user"
		  },
		  {
			"eventtypeid": 7,
			"eventtypename": "get asset"
		  },
		  {
			"eventtypeid": 8,
			"eventtypename": "list assets"
		  },
		  {
			"eventtypeid": 9,
			"eventtypename": "download asset"
		  },
		  {
			"eventtypeid": 10,
			"eventtypename": "export asset"
		  },
		  {
			"eventtypeid": 11,
			"eventtypename": "import asset"
		  },
		  {
			"eventtypeid": 12,
			"eventtypename": "add asset"
		  },
		  {
			"eventtypeid": 13,
			"eventtypename": "add user role"
		  },
		  {
			"eventtypeid": 14,
			"eventtypename": "update user role"
		  },
		  {
			"eventtypeid": 15,
			"eventtypename": "upload asset"
		  },
		  {
			"eventtypeid": 16,
			"eventtypename": "update asset"
		  },
		  {
			"eventtypeid": 17,
			"eventtypename": "delete asset"
		  },
		  {
			"eventtypeid": 18,
			"eventtypename": "delete user"
		  },
		  {
			"eventtypeid": 19,
			"eventtypename": "delete user role"
		  },
		  {
			"eventtypeid": 20,
			"eventtypename": "get event type"
		  },
		  {
			"eventtypeid": 21,
			"eventtypename": "list event types"
		  },
		  {
			"eventtypeid": 22,
			"eventtypename": "add event type"
		  },
		  {
			"eventtypeid": 23,
			"eventtypename": "update event type"
		  },
		  {
			"eventtypeid": 24,
			"eventtypename": "delete event type"
		  }
		]
	  }
	}

/api/eventtype/add

Description
Create a new event type. This requires an administrator account.

Simple DAM Compatibility Level: 1

Parameters

Request (POST)

sessiontoken (string, required)
A valid session token

eventtypename (string, required)
The name of the new event type

Response

error (integer)
An error code, or 0 if none

description (string)
Description of the error, or 'success' if none

data (object)
The returned data object

eventtypeid (integer)
The unique identifier of the new event type

Example Call (POST)

/api/eventtype/add/?sessiontoken=xxxx&eventtypename=new+event+type+name

Example Response

{
	  "error": 0,
	  "description": "success",
	  "data": {
		"eventtypeid": "12"
	  }
	}

/api/eventtype/update

Description
Update an existing event type. This requires an administrator account.

Simple DAM Compatibility Level: 1

Parameters

Request (POST)

sessiontoken (string, required)
A valid session token

id (integer, required)
The event type's unique identifier

eventtypename (string, required)
The new name for the existing event type

Response

Example Call (POST)

/api/eventtype/update/?sessiontoken=xxxx&id=12&eventtypename=updated+event+type+name

Example Response

{
	  "error": 0,
	  "description": "success",
	  "data": {
		"eventtypeid": "12"
	  }
	}

/api/eventtype/delete

Description
Delete an existing event type. This requires an administrator account. Warning: existing events must first be updated to a new type if they are assigned an event type that is to be deleted!

Simple DAM Compatibility Level: 1

Parameters

Request (POST)

sessiontoken (string, required)
A valid session token

id (integer, required)
The unique id of the event type to be deleted

Response

Example Call (POST)

/api/eventtype/delete/?sessiontoken=xxxx&id=12

Example Response

{
	  "error": 0,
	  "description": "success",
	  "data": {
		"eventtypeid": "12"
	  }
	}

SimpleDAM API Documentation

An Introduction to the SimpleDAM API Protocol

Developer Sandbox

API Documentation

List of Calls

asset

/api/asset/get

/api/asset/list

/api/asset/thumbnail

/api/asset/preview

/api/asset/embed

/api/asset/download

/api/asset/add

/api/asset/upload

/api/asset/update

/api/asset/delete

/api/asset/import

user

/api/user/login

/api/user/logout

/api/user/checksession

/api/user/get

/api/user/list

/api/user/add

/api/user/update

/api/user/delete

user role

/api/userrole/get

/api/userrole/list

/api/userrole/add

/api/userrole/update

/api/userrole/delete

event

/api/event/get

/api/event/list

event type

/api/eventtype/get

/api/eventtype/list

/api/eventtype/add

/api/eventtype/update

/api/eventtype/delete