[Social-Desktop] Proposed extensions to the OCS API
Frank Karlitschek
karlitschek at kde.org
Thu May 6 21:59:34 CEST 2010
Hi Ben,
sorry for the late reply. I´m at the road at the moment and not at home.
I like your proposed API extension. I think we can implement it as you suggested.
I will add support for the call next week to the specification.
Thanks for your help. :-)
Cheers
Frank
On 03.05.2010, at 08:56, Ben Cooksley wrote:
> On Sat, May 1, 2010 at 12:07 PM, Ben Cooksley <sourtooth at gmail.com> wrote:
>> Hi all,
>
> ping?
>
>>
>> the following is a proposed extension to the OCS API, it adds support
>> for categories to the knowledge base component.
>> It adds a "categories" call to the knowledge base component which will
>> return a list of all categories supported. It is paged with 100 items
>> per page as the default as the listings are expected to be relatively
>> small, and does not accept any arguments except for pagination.
>>
>> Example XML:
>> <?xml version="1.0"?>
>> <ocs>
>> <meta>
>> <status>ok</status>
>> <statuscode>100</statuscode>
>> <message></message>
>> <totalitems>1</totalitems>
>> <itemsperpage>10</itemsperpage>
>> </meta>
>> <data>
>> <category>
>> <id>number</id>
>> <name>Name of category</name>
>> <description>category desc</description>
>> <icon>web url to icon</icon>
>> <parent>id of parent, 0 if top level</parent>
>> <itemcount>Number of knowledge base items in this category</itemcount>
>> </category>
>> </data>
>> </ocs>
>>
>> Notes:
>> id / parent - for internal use only
>> name / description / itemcount - for display to the user
>> icon - for rendering to the user, should not be displayed raw.
>>
>> This also adds an argument "category" to the list method, which when
>> provided will filter out anything not in that category.
>>
>> Thoughts?
>>
>> Regards,
>> Ben
>>
> _______________________________________________
> Social-Desktop mailing list
> Social-Desktop at kde.org
> https://mail.kde.org/mailman/listinfo/social-desktop
--
Frank Karlitschek
karlitschek at kde.org
More information about the Social-Desktop
mailing list