API Documentation
\

\Sesha_Api

Sesha external API interface.

Copyright 2003-2017 Horde LLC (http://www.horde.org/)

This file defines Sesha's external API interface. Other applications can interact with Sesha through this API.

Summary

Methods
Properties
Constants
listQueues()
getQueueDetails()
listVersions()
getVersionDetails()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
No private properties found
N/A

Methods

listQueues()

listQueues() : array

List categories as ticket queues

Returns

array —

a list of ticket queues with category id as key and category caption as value

getQueueDetails()

getQueueDetails(integer  $queue_id) : array

Get a queueDetails hash for a queue (category)

Parameters

integer $queue_id

The Queue for which to build the details hash

Returns

array —

A hash of category id as id, category label as name, category description as description, a link, a list of subjects as configured

listVersions()

listVersions(integer  $queue_id) : array

List Stock items as versions for a queue (category)

Parameters

integer $queue_id

The category id (queue) for which we want to fetch versions

Returns

array —

A hash containing stock id as id, stock name as name, stock note as description

getVersionDetails()

getVersionDetails(integer  $version_id) : array

return a version details hash by version id

Parameters

integer $version_id

The ID of the stock item to display as a version

Returns

array —

The version hash containing stock name as name, stock note as description and a link